Background
During a review of project-authored documentation, three issues were identified:
-
CLAUDE.md references a nonexistent README section. Lines 42 and 100 of CLAUDE.md point to a "Roadmap / Deferred" section in README.md that doesn't exist. This stale reference could mislead contributors about where to park deferred decisions.
-
AGENTS.md has an incomplete Speckit placeholder. The file contains only a Speckit HTML comment with the sentence "read the current plan" — but no plan file is named or linked. This is an unfilled template placeholder.
-
Mismatched benchmark numbers between docs/benchmarks.md and README.md. The modify+encode throughput tables show diverging numbers. For example, at 60 KB "modify nested": benchmarks.md reports 134,590 ops/s while README.md shows 196,386 ops/s. Same payload, different numbers — confusing for readers.
Goal
Ensure project documentation is internally consistent: remove the stale "Roadmap / Deferred" reference from CLAUDE.md, fill in the incomplete Speckit placeholder in AGENTS.md, and reconcile the divergent benchmark numbers between docs/benchmarks.md and README.md.
Acceptance Criteria
Task Checklist
1. Fix CLAUDE.md stale reference
2. Fix AGENTS.md incomplete placeholder
3. Reconcile benchmark numbers
4. Validation
Background
During a review of project-authored documentation, three issues were identified:
CLAUDE.md references a nonexistent README section. Lines 42 and 100 of
CLAUDE.mdpoint to a "Roadmap / Deferred" section inREADME.mdthat doesn't exist. This stale reference could mislead contributors about where to park deferred decisions.AGENTS.md has an incomplete Speckit placeholder. The file contains only a Speckit HTML comment with the sentence "read the current plan" — but no plan file is named or linked. This is an unfilled template placeholder.
Mismatched benchmark numbers between
docs/benchmarks.mdandREADME.md. The modify+encode throughput tables show diverging numbers. For example, at 60 KB "modify nested": benchmarks.md reports 134,590 ops/s while README.md shows 196,386 ops/s. Same payload, different numbers — confusing for readers.Goal
Ensure project documentation is internally consistent: remove the stale "Roadmap / Deferred" reference from CLAUDE.md, fill in the incomplete Speckit placeholder in AGENTS.md, and reconcile the divergent benchmark numbers between docs/benchmarks.md and README.md.
Acceptance Criteria
docs/benchmarks.mdandREADME.mdagree on modify+encode throughput numbers for any shared scenarioTask Checklist
1. Fix CLAUDE.md stale reference
cargo fmtcontext sentence)2. Fix AGENTS.md incomplete placeholder
3. Reconcile benchmark numbers
4. Validation
make lintif any code comments were touched