Skip to content

Make the hero image say what the heading below it says - #384

Merged
MongLong0214 merged 1 commit into
devfrom
docs-hero-consistency
Aug 1, 2026
Merged

Make the hero image say what the heading below it says#384
MongLong0214 merged 1 commit into
devfrom
docs-hero-consistency

Conversation

@MongLong0214

Copy link
Copy Markdown
Owner

Applied the beautify-github-readme skill in README mode, then scoped to the smallest change that produced a real improvement — which is what the skill asks for.

The finding

The first screen carried three different taglines:

where what it said
alt text "a coding agent must not revive a decision the repository already reversed"
hero.svg "Git remembers what changed. CommitLore remembers why."
the ## heading directly below "Your agents inherit the code. Make them inherit the judgment."

The image was left behind by a positioning change that moved the heading twice and never reopened the SVG.

Changed

  • hero.svg rebuilt. Keeps the split composition, the warm paper palette, and real material from this repository. The headline is now the current positioning. The right-hand card used to show one ruled-out alternative; it now shows an active record beside a superseded one that is withheld — the lifecycle filter is the part of this product no comparable tool has, and the old card demonstrated the part several of them do.
  • commitlore-demo.svg gained <title> and <desc>, via the generator (scripts/record-demo.mjs), not by hand — the file says not to edit it by hand. aria-label on the root served the README's img embed and nothing else.

Two things I checked rather than assumed

  • The skill states GitHub does not play animation embedded inside SVG. That would make our demo render as a nearly blank terminal. Verified against the live page: GitHub serves the file through a plain <img src> byte-identical, all five SMIL <set> elements intact. The animation works. Converting to GIF would have cost the text layer, accessibility and file size for nothing — so it was not done.
  • A rendered preview caught a real defect the first attempt introduced: the bottom caption was clipped at the canvas edge, reading hook con. A well-formedness check would not have found it. Shortened until it fits.

Not done, deliberately

The delivery table stays Markdown. Tables belong in the text layer where they stay selectable and diffable, and the skill says the same.

Verified

check result
skill's audit_readme.py OK — was reporting a missing <title>, now clean
rendered at 1200 and inspected nothing clipped; active and superseded rows both legible
both SVGs parse ok
readme, readme-order, readme-numbers, readme-positioning, compatibility-matrix, demo, manifest 114 passed
check-readme-numbers.mjs exit 0, BENCH block byte-identical
spec/verify.sh OK: 26 fixtures

Known limit, recorded in the commit: the card text is 19–20 units, so at a 360px mobile render it falls below the legible threshold. The headline and alt text carry the message there and the same content is in the Markdown below, but the card is decoration at that width.

The first screen carried three different taglines. The image said "Git remembers
what changed. CommitLore remembers why.", the heading under it said "Your agents
inherit the code. Make them inherit the judgment.", and the alt text said a
coding agent must not revive a decision the repository already reversed. The
image was left behind by a positioning change that moved the heading twice and
never reopened the SVG.

The rebuild keeps what was already right: the split composition, the warm paper
palette, and real material from this repository rather than decoration. What
changes is the headline, and what the card on the right shows. It used to show
one ruled-out alternative. It now shows an active record beside a superseded one
that is withheld, because the lifecycle filter is the part of this product no
comparable tool has, and the old card demonstrated the part several of them do.

The demo SVG gained a `<title>` and a `<desc>`, and the generator gained the
reason. `aria-label` on the root serves the README's `img` embed and nothing
else; a reader who opens the file directly had no name for it. Regenerated
rather than hand-edited, since the file says not to edit it by hand.

The bottom caption was clipped on the first attempt -- it read "hook con" at the
canvas edge -- which a rendered preview caught and a well-formedness check would
not have. Shortened until it fits.

Record-Id: r-heroconsist
Limit: the card text is 19-20 units, so at a 360-pixel mobile render it falls below the legible threshold; the headline and the alt text carry the message there, and the same content is in the Markdown below, but the card itself is decoration at that width
Ruled-out: Converting the animated demo to a GIF | the skill that prompted this review states GitHub does not play animation inside SVG, and GitHub was observed serving this file byte-identical with all five SMIL elements intact, so a GIF would cost the text layer and the file size for nothing
Ruled-out: Turning the delivery table into a chart | tables belong in Markdown where they stay selectable and diffable, and the numbers would have left the text layer
Certainty: firm
Blast: local
Undo: easy
Verified: rendered at 1200 and inspected -- nothing clipped, active and superseded rows both legible; both SVGs parse; readme, readme-order, readme-numbers, readme-positioning, compatibility-matrix, demo and manifest pass at 114; check-readme-numbers.mjs exit 0 with the BENCH block byte-identical; spec/verify.sh OK at 26 fixtures; the skill's own audit_readme.py reports no issues
Unverified: how the hero reads in GitHub's dark theme -- the palette is a fixed light paper and was not re-checked against a dark background
@github-actions

github-actions Bot commented Aug 1, 2026

Copy link
Copy Markdown

CommitLore — record lint

Trailers: clean — 1 commit in origin/dev..788a9db32b88565740e379ccc5727cdec3137489
Active constraints: 2 limits · 6 ruled-out · 1 warnings — from 4 records over 3 changed paths

Active constraints for the paths this PR touches

Limits (2)

  • r-heroconsist 788a9db — the card text is 19-20 units, so at a 360-pixel mobile render it falls below the legible threshold; the headline and the alt text carry the message there, and the same content is in the Markdown below, but the card itself is decoration at that width
  • r-t1016svg 321c6f1 — byte-exactness is verified on this platform; a different platform's Node could in principle render differently, and nothing here proves it does not

Ruled out (6)

  • r-heroconsist 788a9db — Converting the animated demo to a GIF | the skill that prompted this review states GitHub does not play animation inside SVG, and GitHub was observed serving this file byte-identical with all five SMIL elements intact, so a GIF would cost the text layer and the file size for nothing
  • r-heroconsist 788a9db — Turning the delivery table into a chart | tables belong in Markdown where they stay selectable and diffable, and the numbers would have left the text layer
  • r-t1016svg 321c6f1 — a terminal recorder dependency | the artifact would then depend on a tool's output format, and reproducing it would mean reproducing that tool's version
  • r-t1016svg 321c6f1 — a frame manifest with tolerance instead of byte comparison | a check that tolerates drift stops detecting the drift it exists to detect
  • r-6f92c4 3cebb89 — restating the withdrawn numbers as prose ("we measured a reduction") | it is the same claim with the evidence removed
  • r-6f92c4 3cebb89 — leading with the protocol's features and putting the measurement record near the bottom | that is the arrangement of someone hoping it is not read

Warnings (1)

  • r-6f92c4 3cebb89 (claim) — with no numbers, the first-impression case now rests entirely on the test links. If M3-b also comes back null, this framing is what the project has

git log --follow accepts exactly one pathspec, so renames are not followed for 3 paths; query one path at a time to follow its rename chain

withheld the content of 1 record(s) graded blocked: a Verified trailer matching an injection pattern is reported, never quoted (SPEC §7)

Trailer violations fail this check. Active constraints are informational — they are what the repository already decided, not a verdict on this PR.

@MongLong0214
MongLong0214 merged commit 916dbac into dev Aug 1, 2026
8 checks passed
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