Repository navigation
Bring the README in line with the Relay repositories - #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.
Before: the README opened with a plain heading and had no artwork, demo, or documentation index, so it didn't look like Relay Chat or Relay Cards.
After: the README opens with a full-width banner. The Relay mark and the name are on the left, and the real viewer is drawn as a terminal panel on the right, showing levels, the following indicator, a selected error with its stack frame, and a highlighted search match. The sections follow the same order as the other Relay repositories: Try the demo, usage, controls, integrations, Documentation, Scope, Development, and License.
.github/social-preview.pngrecomposes the same art at 2:1, anddocs/assets/ARTWORK.mdrecords the direction.New supporting pieces:
npm run demoandnpm run demo:plainopen a sample log inexamples/app.logthat mixes text, JSON, and logfmt lines and includes a stack trace. The keyboard reference and the recognized formats moved intodocs/keyboard.mdanddocs/formats.md.How: the banner and preview use the official mark from the organization profile, unchanged, with the shared Relay palette and monospace type. The terminal content mirrors what the viewer actually renders.
This targets main and also carries #2, #3, and #4. Those PRs were merged into their stacked branches rather than main, so their code (filters, the viewer, and the Relay Cards and Log Howl pairing) only reaches main through this PR. The social preview has to be uploaded once by hand under Settings › General › Social preview.