docs(library-binary-numbers,bare): trim internal-test ref#147
Merged
Conversation
Both library READMEs ended with:
See the rendered Mermaid graphs for every state in `states.md`
(regenerated via `npm run docs:states` from the repo root; the
spec at `src/graphs.spec.ts` only verifies structural properties
of the graphs, not the markdown file).
The `src/graphs.spec.ts` part is internal — npm consumers don't care
how the maintainer keeps `states.md` in sync. Trim to:
See the rendered Mermaid graphs for every state in `states.md` —
regenerated via `npm run docs:states` from the repo root.
`npm run docs:states` stays because it's user-actionable for anyone
who clones the repo.
Identical change to both READMEs — the paired-libraries parallelism
rule (see the engine CLAUDE.md) holds.
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.
Summary
Both library READMEs ended with a parenthetical referencing the internal spec file `src/graphs.spec.ts`. The note is maintainer-facing trivia — npm consumers don't need to know how the maintainer keeps `states.md` in sync.
Trimmed to one clean sentence per file:
`npm run docs:states` stays — it's user-actionable for anyone who clones the repo.
Paired change. The two libraries' READMEs are kept structurally identical per the rule in the engine CLAUDE.md ("Documentation parity for the two binary libraries"). Both get the exact same edit in the same diff.
Test plan
Doc-only, no code touched.