Repository navigation
docs: rewrite README for newcomers (EN/ZH) - #1537
Merged
Merged
Conversation
The README had compressed into comma-separated keyword lists that satisfy the doc-drift gates without teaching anyone anything — a stranger could not tell what Roll is, what it needs, or what to type first. Rewrite both locales around a newcomer: what Roll does in six plain steps, the four prerequisites (including that agent tokens bill your own accounts), a seven-step first task, a real `roll status` frame with a line-by-line reading, and the questions people actually ask first (will it break my code, what if I close the terminal, how do I know it isn't lying). Contract detail moves under "Going deeper" instead of being the first thing a reader hits. Every gated payload is kept, including the `#### Local exact-model rig readiness` / `Honest boundaries` snapshot markers; the snapshot is updated for the new prose. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The US-DELTA-014/021 doc contract requires every README to name `roll supervisor delivery` and to link the delivery-metrics guide. Add the command to the cycle-inspection block and the guide to the docs table. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
The README had stopped explaining Roll to anyone who did not already know it. Both locales are rewritten for a newcomer:
roll statusframe with a line-by-line readingContract detail still ships, moved under a "Going deeper" section rather than being the first thing a reader hits. Every gated payload is preserved and the 15 README doc-drift test files pass (155 tests); the
delta-rigs-docssnapshot is updated for the new prose.🤖 Generated with Claude Code