docs: rewrite README voice, trim CLAUDE.md to invariants - #40
Merged
Merged
Conversation
The README read like generated prose: 28 em-dash asides, metaphors the
repo's own doc rules ban ("the generator's fingerprints", "not the same
kind of nothing"), and filler intensifiers. Same claims, plainer
sentences, 6 em dashes left.
CLAUDE.md dropped from 289 to 140 lines. Kept the invariants that are
expensive to rediscover from the code (fail-safe rule, verdict
vocabulary and where it is decided, shared seams, stdlib-only .pyz,
exit-code contract); dropped the prescriptive workflow sections.
The Vietnamese README was restructured separately; fixed four anchors
that pointed at English headings docs/vi/usage.md does not have, and a
stray non-Vietnamese word in the contributing note.
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 read like generated prose: 28 em-dash asides, metaphors the repo's own doc rules ban ("the generator's fingerprints", "not the same kind of nothing"), and filler intensifiers. Same claims, plainer sentences, 6 em dashes left.
CLAUDE.md dropped from 289 to 140 lines. Kept the invariants that are expensive to rediscover from the code (fail-safe rule, verdict vocabulary and where it is decided, shared seams, stdlib-only .pyz, exit-code contract); dropped the prescriptive workflow sections.
The Vietnamese README was restructured separately; fixed four anchors that pointed at English headings docs/vi/usage.md does not have, and a stray non-Vietnamese word in the contributing note.