docs: restructure the README for scanning - #26
Merged
Conversation
Rebuilt around the 10-second header / 60-second quickstart shape: centred hero with a one-line value proposition, an anchor nav bar, and badges trimmed from seven to six by dropping the ORCID badge, which is an author identifier rather than a project status. The quickstart is now one copy-paste block that clones, builds and lints, with the prerequisite on one line. It leads the page instead of sitting below three screens of prose. Prose walls become structure: the "Why" bullets are a table, a mermaid flowchart replaces the description of how partials reach dist and which gate runs where, and the repository tree, the branded-template gallery and the supply-chain notes move into collapsibles so the main page stays light. Visible screenshots drop from nine to three. Rule counts corrected against the source: 14 universal and 13 house, 27 total. The house row now lists all thirteen invariants rather than the four it named before #24 added the rest.
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.
What & why
Rebuilt around the 10-second header / 60-second quickstart shape.
distand which gate runs where, and the repository tree, branded-template gallery and supply-chain notes move into<details>.Rule counts corrected against the source: 14 universal, 13 house, 27 total. The
houserow now lists all thirteen invariants rather than the four it named before #24 added the rest.Verified on the rendered page, not just locally
Loaded the branch's README on GitHub in a real browser:
<details>, both[!TIP]/[!WARNING]alerts render##anchors match the nav bar linksGitHub's mermaid iframe was still "Loading" in the headless session, so I validated the diagram source directly against mermaid 11: it parses and renders to a 22KB SVG with all 14 expected node labels.
Checklist
node framework/build/build.mjs(and anyscripts/build-template.mjs <dir>) rebuilt, output committednode framework/build/lint.mjs --profile house <output>passes (0 fail)Screenshots
Documentation only — no email render changes.