Skip to content

readme: a masthead, badges with their own space, and a one-line contents - #41

Merged
pAulseperformance merged 1 commit into
masterfrom
improve/masthead
Nov 17, 2026
Merged

pAulseperformance merged 1 commit into
masterfrom
improve/masthead

Conversation

@pAulseperformance

Copy link
Copy Markdown
Owner

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.

  • Title centred on its own line.
  • Badges on two centred rows, split by what they measure: identity (awesome, licence, PRs) and live numbers (the list's own count, last commit, views).
  • One line of contents, closed by default. The ## Contents heading sits inside the disclosure so the standard still finds it, and the collapsed state reads "Contents · 10 sections".
  • Two plain lines under the badges: the links are checked on every change, and a newcomer's first three clicks.

Measured on this branch: awesome-lint 0 errors, check_links.py 0 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.

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.
@pAulseperformance
pAulseperformance merged commit aaa9954 into master Nov 17, 2026
2 checks passed
@pAulseperformance
pAulseperformance deleted the improve/masthead branch November 17, 2026 05:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant