docs: fix stale references, incomplete content, and benchmark number mismatches

[membphis]

关联 Issue

Closes #55

做了什么

• Remove stale "Roadmap / Deferred" references in CLAUDE.md (lines 42, 100)
• Fix AGENTS.md Speckit placeholder to point to CLAUDE.md and specs/
• Reconcile modify+encode benchmark numbers between README.md and docs/benchmarks.md

为什么这样做

Three documentation issues were identified during a review:

1. CLAUDE.md referenced a nonexistent "Roadmap / Deferred" section in README.md
2. AGENTS.md contained an incomplete Speckit template placeholder
3. README.md and benchmarks.md showed diverging modify+encode throughput numbers

All fixes are docs-only — no code changes.

如何验证

• cargo test --release: 152 passed
• make lint: 0 warnings
• Full end-to-end re-read of all three files confirms no stale references remain
• All benchmark numbers now match across files

Breaking Changes

无

Summary by CodeRabbit

• Documentation
  • Updated benchmark documentation with refreshed performance metrics for encoding operations
  • Enhanced documentation pointers to project architecture and specifications resources

[coderabbitai]

Warning

Review limit reached

@membphis, we couldn't start this review because you've used your available PR reviews for now.

Your plan currently allows 1 review/hour. Refill in 53 minutes and 39 seconds.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more review capacity refills, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than trial, open-source, and free plans. In all cases, review capacity refills continuously over time.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 057528e1-b510-486b-95cd-7a95cd583e19

📥 Commits

Reviewing files that changed from the base of the PR and between 9716aaf and 63094f8.

📒 Files selected for processing (1)

• README.md

📝 Walkthrough

Walkthrough

Three documentation files are updated to fix stale references and incomplete content. AGENTS.md adds a pointer to CLAUDE.md and specs/; CLAUDE.md removes nonexistent README section references and redirects deferred-item tracking to GitHub Issues; README.md simplifies the benchmark table and emphasizes memcpy re-emission, with a pointer to docs/benchmarks.md for details.

Changes

Documentation consistency fixes

Layer / File(s)

Summary

Fix documentation references and benchmark details AGENTS.md, CLAUDE.md, README.md

AGENTS.md adds a Speckit documentation pointer directing readers to CLAUDE.md and specs/ for project structure and feature specification. CLAUDE.md removes stale references to a nonexistent "Roadmap / Deferred" section in README.md (lines 42 and 100) and updates deferred-item tracking to use individual GitHub Issues. README.md simplifies the "Encode (unmodified) + modify-then-re-encode" benchmark table, removes cjson comparison columns, and revises the explanation to emphasize memcpy re-emission for unmodified encode and subtree-only materialization for modified cases, with a reference to docs/benchmarks.md for the full benchmark set.

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 6

✅ Passed checks (6 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the documentation-only changes: fixing stale references in CLAUDE.md, incomplete content in AGENTS.md, and reconciling benchmark numbers in README.md.
Linked Issues check	✅ Passed	All three requirements from issue #55 are addressed: CLAUDE.md stale references removed, AGENTS.md placeholder replaced with meaningful pointers to CLAUDE.md and specs/, and benchmark numbers reconciled between README.md and docs/benchmarks.md.
Out of Scope Changes check	✅ Passed	All changes are documentation-only and directly address the three issues outlined in #55; no out-of-scope modifications to code, configuration, or unrelated documentation sections.
E2e Test Quality Review	✅ Passed	PR is documentation-only with no code or test changes; E2E test quality check not applicable to markdown-only fixes for documentation consistency.
Security Check	✅ Passed	Documentation-only PR with no code changes; no sensitive data exposure, credentials, or security misconfigurations detected in AGENTS.md, CLAUDE.md, or README.md.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/fix-docs-stale-refs-and-numbers

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

This PR updates project documentation to remove stale references, fill an incomplete placeholder, and align benchmark numbers so readers see consistent guidance across docs.

Changes:

• Removes outdated CLAUDE.md references to a nonexistent “Roadmap / Deferred” section and updates the guidance for deferred decisions.
• Adds AGENTS.md content to replace the previous placeholder and point contributors to existing docs.
• Reconciles README.md modify+encode benchmark numbers to match docs/benchmarks.md and clarifies provenance.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
README.md	Updates modify+encode benchmark table and adds a note tying numbers to docs/benchmarks.md.
CLAUDE.md	Removes stale README section references and updates contributor guidance for deferred work.
AGENTS.md	Replaces placeholder with pointers for project structure/conventions and feature plans.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.