Repository navigation
docs: add the Relay banner, social preview, and README sections - #6
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 relay-ui README was plain text with no banner or social preview, and its sections did not follow relay-chat and relay-cards.
After: the README opens with a full-width banner in the Relay style: the official mark and a large "RELAY UI" on the left, and on the right the real components drawn as terminal panels (a request table with a selected row and colored statuses, spinners in their running, done and failed states, and rendered Markdown). The sections follow the sibling READMEs: Try the demo, Use the components, Components, Documentation, Scope, Development, License.
.github/social-preview.pngrecomposes the same panels for 2:1 thumbnails, anddocs/assets/ARTWORK.mdrecords the direction.How: the art is drawn by
docs/assets/draw-artwork.pyfromrelay-avatar.png, with the mark cut cleanly from its background, so it can be redrawn when a component changes. The social preview still has to be uploaded once under Settings → Social preview, since GitHub does not read it from the repository.