docs: restructure README around a validity-ladder framing - #2154
Merged
Conversation
…eal numbers Full structural rewrite of README.md: drops the marketing-adjacent framing (badges, adjective-heavy sections) in favor of a research-program voice organized around six escalating validity levels (structural, regression, scale, model, temporal, external). Backfilled the numbers the rewrite had left vague or missing: - Tri-comparison coverage: 24/45 languages get all three tools, 16 more get two, 5 are manual-verification-only; 87 of 180 logged discrepancy shapes are validated (48%) -- computed fresh from tri_comparison_ledger.json. - Test count: 7,043 tests in the default suite, 6,165 per-signature tests specifically -- re-collected live rather than copied from the stale 3,649 figure. - Added hyperlinks to tri_comparison_README.md, tri_comparison_points_of_interest.md, update_golden_master.py, why_gitgalaxy_beats_ast_here.md, and cross-section anchors. Also reconciled docs/how_to_maintain_the_readme.md's section-order list and tone-bar section names with the new structure, and flagged what the rewrite silently dropped (badges, Weakness Classes, Real-World Adoption, Tools & Use Cases) as an open question rather than a settled decision. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
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
tri_comparison_README.md,tri_comparison_points_of_interest.md,update_golden_master.py,why_gitgalaxy_beats_ast_here.md).docs/how_to_maintain_the_readme.md's section-order list and tone-bar section names with the new structure, and explicitly flagged what the rewrite dropped (badges, Weakness Classes, Real-World Adoption, Tools & Use Cases) as an open question for a future pass rather than a settled decision.Known open gaps (tracked in the maintenance doc, not fixed here)
tests/README.mdstill cites the stale3,649test count (out of scope for this PR).Test plan
pytest tests/ --collect-only -q(7,043) andpytest tests/extraction/languages/ --collect-only -q(6,165)docs/self_scan/tri_comparison_ledger.json(180 entries, 87 validated)🤖 Generated with Claude Code