Repository navigation
docs: bring the README in line with the Relay visual direction - #5
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 Forms README opened with a plain heading and had no artwork, no social preview, and no Documentation section, so it did not look like Relay Chat or Relay Cards.
After: the README opens with a full-width banner (the Relay mark and RELAY FORMS on the left, the real interface on the right as three terminal panels: a wizard's progress row, a single-choice prompt, and an unsaved setting in the configuration editor). The repository has a matching 2:1 social preview, a
docs/assets/ARTWORK.md, and the same section order as Relay Chat: demo, usage, keys, Documentation, Scope, Development, License.How: the art was laid out in HTML with the shared Relay palette and the official mark from the organization profile, then rendered with headless Chrome, so the panel text matches what the demos actually draw. The social preview still has to be uploaded in the repository settings (Settings > General > Social preview) to take effect.