docs: cut the README to an operator front door - #301
Merged
Conversation
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.
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.
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:
Moved, not deleted:
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.