Skip to content

docs: match the Relay README and artwork direction - #6

Merged
autoantohaki merged 4 commits into
mainfrom
docs/readme-visuals
Oct 22, 2026
Merged

autoantohaki merged 4 commits into
mainfrom
docs/readme-visuals

Conversation

@autoantohaki

Copy link
Copy Markdown
Member

Requested by mau

Before: the README opened with a plain heading and had no banner, social preview, Documentation section, or Scope section, so it did not look like Relay Chat or Relay Cards.

After: a full-width banner with the Relay mark and the product name on the left and the real demo on the right (focused host list, detail and events panes, status bar, key hints), a 2:1 social preview, docs/assets/ARTWORK.md, and a README in the same section order and tone as relay-chat: demo, controls, package use, feature summaries, Documentation, Scope, Development, License.

How: both images are drawn from HTML in docs/assets/source/ using the Relay palette and a vector redraw of the official mark, then captured with headless Chrome. ARTWORK.md records the command. The social preview still has to be uploaded in the repository settings.

Merge #5 first; this branch is built on it, so the diff shrinks to the docs change once #5 is in.

@autoantohaki
autoantohaki merged commit f11a1d5 into main Oct 22, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant