Tighten the README into something that reads at a glance - #27
Merged
Conversation
The content was already there; the shape was working against it. - The table of contents sat below Quick start, a third of the way down, where a reader who wanted it had already scrolled past. It is now a single compact row under the hero, covering every section rather than the ten it listed. - The two platform callouts were plain blockquotes. They are GitHub alerts now, so the Windows tip and the macOS beta note read as asides instead of body copy. - "What it actually does" was seven long bullets that all started at the same weight, so nothing led. Same seven claims as a table with the hook in the left column, which is scannable in a way the list never was. Two of them also still counted only the cat's 14 coats and named only the meow and the purr. - "Download for Windows" was an H3 acting as a button, which put a fake entry in the heading outline. It matches the hero's badge now.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
The content was already strong. The shape was working against it. Four changes,
all verified against GitHub's real renderer rather than assumed.
The table of contents was a third of the way down
It sat below Quick start, so anyone who wanted it had already scrolled past
the thing it was meant to help them skip. It is now a single compact row under
the hero, and it covers all 13 sections rather than the 10 it happened to list.
The platform callouts were plain blockquotes
> **Windows...**and> **macOS (beta)...**rendered as indented body copy.They are
> [!TIP]and> [!NOTE]now, so GitHub gives them its own callouttreatment with an icon and a coloured rule, and they read as asides instead of
paragraphs you have to parse to realise are optional.
"What it actually does" was seven bullets that all led with the same weight
Nothing to anchor on while scanning. Same seven claims, now a table with the
hook in the left column. Two of them were also quietly out of date: one counted
only the cat's 14 coats when there are 28 across both species, and one listed
"the meow, the purr, the chirp" without the dog's voice.
"Download for Windows" was an H3 pretending to be a button
That put a fake entry in the heading outline. It is a badge now, matching the
one already in the hero.
Testing
on github.com itself: both alerts resolve to
markdown-alert-tip/markdown-alert-note, the nav and the feature table render as intended(the
#meet-the-catlink was the only one affected by any of this and it stillresolves)
line starting with a dangling
·. The separators bind to the link before themnow, so a wrap can never lead with one