Skip to content

docs: cut the README to an operator front door - #301

Merged
sanlee-ys merged 1 commit into
mainfrom
docs/readme-front-door
Aug 18, 2026
Merged

docs: cut the README to an operator front door#301
sanlee-ys merged 1 commit into
mainfrom
docs/readme-front-door

Conversation

@sanlee-ys

Copy link
Copy Markdown
Owner

Why

The README was 517 lines and 4,221 words. Most of that was the same honesty speech after every command. A stranger could not say what the repo does after the first screen.

What changed

README.md is now 223 lines and about 1,000 words. Commands, pictures, and claims stay. Sermons leave.

Kept:

  • four install paths (source, scoop, direct download, winget-not-yet)
  • both hero pictures (council and HUD), same files the image tests emit
  • the three statusline JSON blocks (doctor points at this section)
  • \xattr -d\ outside the main \curl\ block (PARITY.md)
  • snapshot meaning table, honest-gauge rule, fixture rule

Moved, not deleted:

  • v1 cut argument → already in \docs/design.md\ §1
  • signing and Gatekeeper walk → already in \SECURITY.md\
  • scoop and winget argument → already in \packaging/\
  • council detail → already in \docs/council.md\
  • snapshot schema and events boundary → already in \docs/design.md\ §7.22 / §7.21

Verify

No Go file changed. No test reads \README.md. Image tests compare the SVG files, which this PR does not touch.

CI on this PR is the gate.

Merge

This is public front-door copy. Do not merge until you read the page aloud and accept it as the specimen.

Drop the caveat sermons. Keep the four install paths, both pictures, the statusline paste blocks, and the honesty claims. Proof stays in SECURITY.md, packaging/, docs/council.md, and docs/design.md.
@sanlee-ys
sanlee-ys merged commit 8955027 into main Aug 18, 2026
5 checks passed
@sanlee-ys
sanlee-ys deleted the docs/readme-front-door branch August 18, 2026 13:43
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