docs: lead the README with the demo card - #9
Merged
Merged
Conversation
The link to the live page sat twenty to thirty lines down, under the architecture paragraph, so the first impression of the repo was prose. Now the first thing in the README is a card carrying this project's headline number, and clicking it opens the demo. The same image is the og:image on the page, so a shared link previews the finding instead of a bare URL. Also drops the lateral "also:" footer links: each demo belongs to its own repository and has no reason to advertise the others.
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
1 participant
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.
Hero card at the top of the README, linked to the live demo, and the same image as
og:imageso shared links preview the finding. Removes the lateralalso:footer links.