Goal
Restructure README.md so a first-time visitor reaches a working quickstart
before philosophy/scope content, can navigate the ~1968-line file, and isn't
given an overstated speed claim for the fastest onboarding path.
Background
A documentation review focused specifically on new-user first impressions
found:
README.md has no table of contents despite 18 top-level ## sections and
~1968 lines — the single biggest scannability failure for a doc this long.
README.md:21-61 — between the one-paragraph pitch (lines 8-19) and the
"Start Here" quickstart (line 62), the README inserts "Why Base Exists"
(philosophy/links) and "Source Control And Forge Support" (Mercurial/
Perforce-out-of-scope, GitHub-primary caveats) content. A first-time reader
hits governance/scope material before seeing a single runnable command.
README.md:64-117 — the "90-Second Proof" section's own instructions
(read manifest-review guidance, run trust status, hand-copy a printed
digest into trust allow, repeat the clone/review/trust-allow cycle for a
second repo) realistically take several minutes of careful reading, not 90
seconds — an overstated claim right at the top of the front door.
README.md:329-1291 — "Product Layers And Shipped Commands" is one
continuous ~960-line section (nearly half the file) that inlines the full
command reference, duplicating docs/command-reference.md and
docs/technical-overview.md, and forces anyone scrolling past the pitch to
wade through ~1,000 lines before reaching Compatibility, Shell Startup, or
License.
README.md:8-11 — the opening value proposition leads with the undefined
term "local operating contract" in a dense multi-verb clause instead of a
one-sentence plain-English gloss a newcomer can parse in one pass.
Scope
README.md structure and ordering only (no content-accuracy changes
required here; see companion issues for factual fixes).
Acceptance Criteria
Validation
git diff --check; read the rendered README top-to-bottom and confirm a
first-time reader reaches a runnable command within the first ~50 lines.
Non-Goals
- Rewriting the full command reference content itself.
- Changing the underlying product positioning or terminology choices beyond
defining them on first use.
Project Metadata
- Priority: P1
- Size: M
- Area: Docs
- Initiative: Adoption Polish
- Agent Assignment: Human first (structural/editorial judgment call)
Goal
Restructure
README.mdso a first-time visitor reaches a working quickstartbefore philosophy/scope content, can navigate the ~1968-line file, and isn't
given an overstated speed claim for the fastest onboarding path.
Background
A documentation review focused specifically on new-user first impressions
found:
README.mdhas no table of contents despite 18 top-level##sections and~1968 lines — the single biggest scannability failure for a doc this long.
README.md:21-61— between the one-paragraph pitch (lines 8-19) and the"Start Here" quickstart (line 62), the README inserts "Why Base Exists"
(philosophy/links) and "Source Control And Forge Support" (Mercurial/
Perforce-out-of-scope, GitHub-primary caveats) content. A first-time reader
hits governance/scope material before seeing a single runnable command.
README.md:64-117— the "90-Second Proof" section's own instructions(read manifest-review guidance, run
trust status, hand-copy a printeddigest into
trust allow, repeat the clone/review/trust-allow cycle for asecond repo) realistically take several minutes of careful reading, not 90
seconds — an overstated claim right at the top of the front door.
README.md:329-1291— "Product Layers And Shipped Commands" is onecontinuous ~960-line section (nearly half the file) that inlines the full
command reference, duplicating
docs/command-reference.mdanddocs/technical-overview.md, and forces anyone scrolling past the pitch towade through ~1,000 lines before reaching Compatibility, Shell Startup, or
License.
README.md:8-11— the opening value proposition leads with the undefinedterm "local operating contract" in a dense multi-verb clause instead of a
one-sentence plain-English gloss a newcomer can parse in one pass.
Scope
README.mdstructure and ordering only (no content-accuracy changesrequired here; see companion issues for factual fixes).
Acceptance Criteria
README.mdhas a table of contents (or equivalent jump-nav) near thetop.
philosophy/scope caveats moved after it (or linked out rather than
inlined).
the steps are trimmed to genuinely fit the claim.
trimmed to a summary with a link to
docs/command-reference.md/docs/technical-overview.md, or clearly marked as a skippable deepreference so it doesn't block a first read-through.
term) in plain language on first use.
Validation
git diff --check; read the rendered README top-to-bottom and confirm afirst-time reader reaches a runnable command within the first ~50 lines.
Non-Goals
defining them on first use.
Project Metadata