docs: retire CLAUDE.md, keeping what is still true - #251
Open
BenjaminDEMAILLE wants to merge 1 commit into
Open
Conversation
Per #196: the file was added so contributors using Claude would start from the same place, and it has drifted. Its status figures, known-issue list and PE numbers were all stale, its dependency list is superseded by DEPENDENCIES.md (#209), and its build commands duplicate CONTRIBUTING.md. Two sections were worth keeping and are now in CONTRIBUTING.md, next to the rules they belong with: - "when a STAR-faithful change makes the numbers worse" — keeping an approximation because it currently measures better is how a port stops converging, which is worth saying to every contributor and not only to an agent. - the code conventions: camelCase parameter spelling, num_args and allow_hyphen_values, validation in Parameters::validate, no async, thiserror/anyhow. The source-layout tree is deliberately not carried over: it was already wrong (no degnorm/, no solo/ detail), and a hand-maintained file tree drifts faster than anything it documents. Every reference to the file is updated rather than left dangling: the publish exclude list in Cargo.toml, two pointers in DIVERGENCE.md, the faithfulness baseline in CONTRIBUTING.md, and three mentions in STAR-RS-COMPARISON.md. Closes #196.
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.
Closes #196, implementing James's proposal.
What goes
CLAUDE.mdin full. Its status figures ("396 tests passing"), known-issue list and PE numbers were all stale, its dependency section is superseded byDEPENDENCIES.md(#209), and its build commands duplicateCONTRIBUTING.md.What stays, moved into CONTRIBUTING.md
Two sections were saying something the rest of the docs do not, and neither is agent-specific:
num_argsandallow_hyphen_values, validation inParameters::validate(), no async,thiserrorandanyhow.What is deliberately not carried over
The source-layout tree. It was already wrong (no
degnorm/, nosolo/detail), and a hand-maintained file tree drifts faster than the code it describes.cargo docand the module-level docs do that job without going stale.Dangling references
Removing a file that five places point at is how a docs cleanup makes things worse, so each pointer is updated rather than left:
Cargo.toml: dropped from the publishexcludelist.DIVERGENCE.md: two "see CLAUDE.md" pointers now nameSTAR-RS-COMPARISON.mdandROADMAP.md.CONTRIBUTING.md: the faithfulness baseline points atROADMAP.md.STAR-RS-COMPARISON.md: three mentions rephrased, keeping the point that the figures there were stale.grep -rn CLAUDE.mdover the tracked tree comes back with only those rephrased mentions.cargo buildand the library tests are green.🤖 Generated with Claude Code