Repository navigation
readme: a masthead, badges with their own space, and a one-line contents - #41
Merged
Merged
Conversation
The title carried six badges inline, so the first thing a reader saw was a wrapped strip of shields fighting the heading. The badges now sit on two centred rows by what they measure: identity on the first, the list's own count, the last commit and the view count on the second. The contents was eighteen lines of bullets, which put every section of the list below the fold. It is now one line that opens on demand. The heading is inside the disclosure, so the collapsed state reads "Contents · 10 sections" and the standard still sees the heading and its list. Two lines under the badges do the job the old bold sentence could not: one says the links are checked on every change and links to the check, the other sends a newcomer to the v6 manual, the FAQ, or the runtimes section. All three claims are measurable: awesome-lint 0, check_links 0 dead, and the badge's own counter still reads 92 entries in 10 sections on this file.
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.
The top half, rebuilt.
What was wrong. Six badges inline with the title, so the first thing a reader saw was a wrapped strip of shields fighting the heading. Then eighteen lines of contents, which put every actual section below the fold. The only other thing in the first screen was a bold sentence that repeated the repo description.
What it is now.
## Contentsheading sits inside the disclosure so the standard still finds it, and the collapsed state reads "Contents · 10 sections".Measured on this branch: awesome-lint 0 errors,
check_links.py0 dead, and the badge's own counter reads 92 entries in 10 sections for this file, so the number on the badge will not move.Nothing in the 86 entries below the contents changed.