Repository navigation
docs: add the Relay banner, social preview, and documentation index - #3
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by mau
Before: the README opened with a plain
# Relay Dashheading and had no artwork, unlike Relay Chat and Relay Cards.After: the README opens with a full-width banner in the same direction as the other Relay repositories: the Relay mark, a large product name, and a one-line description on the left, and the real dashboard drawn as terminal panels on the right (the services table with ready state, queue depth, and models, and pack-sentinel incidents by severity). A matching 2:1 social preview is in
.github/social-preview.png, at the same sizes as Relay Chat (2172×724 and 1774×887). The README gains a Documentation section and follows the same section order and tone.How: the art is an SVG composition in
docs/assets/artwork.htmlusing the Relay palette, rendered with headless Chrome;docs/assets/ARTWORK.mdexplains the composition and how to re-render it. The social preview still has to be uploaded once under Settings → Social preview.Merge order: this can go before or after #1 and #2. Whichever merges second needs a small README merge, which I'll do.