Repository navigation
docs: add a project-native hero and workflow diagram to the root READMEs - #28
Merged
Merged
Conversation
README mode, visual refresh. The information architecture and copy are unchanged; this adds the visual layer the collection index was missing. - assets/readme/hero.svg and hero.zh-CN.svg: collection identity plus the real anatomy of one Skill (SKILL.md, VERSION, the bilingual README pair, and references/ or tests/ when needed, which only some Skills carry) - assets/readme/workflow.svg and workflow.zh-CN.svg: the four steps from a Skill change to a versioned release - pure SVG with its own background and no script, foreignObject, or remote references; the locale variants are named as a document family so the i18n parity audit treats each pair as one target
Measured contrast showed 6 of 10 text elements below the 4.5:1 AA threshold for normal text: the accent (#2563EB, 3.35-3.72) and the faint gray (#6B7684, 3.75-4.16) were both too dark on the near-black canvas. Replace the text palette with a ramp where every level clears 4.5:1, lighten the card surface for clearer module separation, and move the smallest labels from 16 to 18 units (12px to 13.5px at GitHub content width) so they leave the nonessential-metadata size band.
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.
Stacked on #27. Review and merge #27 first; GitHub retargets this PR to
mainwhen the base branch is deleted.Mode (user-confirmed)
README mode — visual refresh. The information architecture and copy are
unchanged; this only adds the visual layer the collection index was missing.
Pure SVG was chosen (deterministic typography/geometry, no ImageGen material),
and no GIF: there is no meaningful motion case here.
Assets
assets/readme/hero.svg/hero.zh-CN.svgassets/readme/workflow.svg/workflow.zh-CN.svgBoth are pure SVG, 1200-unit
viewBox, own background, system fonts only, with<title>/<desc>and noscript,foreignObject, or remote references.Facts in the visuals are taken from the repository:
SKILL.md,VERSION, andthe bilingual README pair exist in all 8 Skills, while
references/andtests/are labelled "when needed" because only 5 of 8 Skills carry tests.Placement: hero at the top of the existing centered block; workflow immediately
after the maintainer bullets it summarises.
Design decisions
#2563EBaccent taken from theexisting collection-version badge, plus two neutral grays. No new brand colour
was invented.
circuit pattern.
and intro paragraph already state it, and repeating it a third time made the
first screen decorative rather than clearer. The hero's job is identity plus
the anatomy the Markdown does not show.
hero.svg/hero.zh-CN.svg) so the i18n parity audit compares each pair as one target —this is the first real use of the checker fix in docs: make release notes bilingual and backfill v0.3.0/v0.4.0 #27.
Evidence
audit_readme.py README.mdaudit_readme.py README.zh-CN.mdaudit_repo_i18n.py— root README pairgit diff --cached --checkpublic_repo_check.py --staged --require-feature-branchpublic_repo_check.py --changed-since origin/main --check-remoteNot verified
file://URLs underits URL policy and the computer-use backend returned
nodeRepl.fetch request failed; I did not route around either. Renders inspected locally are at/tmp/readme-preview/(hero-900.png,hero.zh-CN-900.png,workflow-900.png,workflow.zh-CN-900.png, plus full-page renders).thumbnail renderer only produces the top region; the workflow embed was
verified structurally in the rendered HTML and as a standalone 900px render.
Open question for the reviewer
The hero repeats the repository name, and the Markdown
# WardLu SkillsH1 sitsdirectly below it. That is the conventional hero pattern and keeps a text title
for accessibility and search, but if you prefer, the hero can move below the
badge row, or the H1 can be dropped in favour of the hero's alt text.
Accessibility (added after review)
The first version of these assets did not meet WCAG AA. Measured contrast
showed 6 of 10 text elements below the 4.5:1 threshold for normal text:
#2563EBon#0B0F14#6EA8FE#2563EBon#151B23#6EA8FEon#171F29#6B7684on#151B23#93A1B0at 18u#6B7684on#0B0F14#93A1B0at 18u#2563EBon#151B23#6EA8FEon#171F29#93A1B0on#151B23#AAB4C0at 18u#E8EDF3#E8EDF3#E8EDF3Changes made:
canvas and the card surface; most levels clear 7:1.
#2563EBto a lightened tint#6EA8FEof the same hue, so the dark canvas keeps the project's colourwithout failing contrast.
width) so they leave the "nonessential metadata only" size band.
#171F29for clearer module separation.Result: 0 of 10 text elements below AA; 7 clear the 7:1 AAA threshold.
Other criteria
<title>/<desc>inside each SVG plus meaningfulalton every embed.present as page text — the H1 and subtitle, the skills table, and the
maintainer bullets that name
SKILL.md, the version, README locales,references and tests, and the four release steps. The imagery carries identity
and hierarchy, which is the presentational case, not the only copy of a fact.
separation comes from the surface fill plus a
#2C3746stroke.reader's GitHub light/dark theme.
Not verified
Contrast was computed arithmetically from the frozen hex values and the rendered
size at 900px. No automated accessibility auditor (axe/pa11y) was run, and no
screen-reader pass was performed.