Skip to content

docs(readme): fix stale claims, compress status + roadmap (review pass) - #25

Merged
bennischober merged 2 commits into
mainfrom
docs/readme-review
Oct 24, 2026
Merged

bennischober merged 2 commits into
mainfrom
docs/readme-review

Conversation

@bennischober

Copy link
Copy Markdown
Owner

What

The README review pass — the five changes reviewed and approved in this thread:

  1. Badges: dropped the hard-coded version badge (was stale at 1.0.0); crates.io badge shows the real latest and cannot go stale.
  2. Status blockquote: 10 lines of §/D references → 3 lines; details live in Using it, history in the CHANGELOG.
  3. "15 frame types" → "17 frame types" (counted in framing.rs; the dry-run ACK and tree worker/file frames were added since the claim was written).
  4. Decision ranges: "(D1-D19)" and "D1–D17" → "D1–D22" (the ledger's real range — the old mentions also skipped D20); dashes unified.
  5. Roadmap: 78 lines of release history → 24 (one line per release + the "deliberately not planned" list); the 0.4 line no longer misdates negation (0.7.1). Full history stays in the CHANGELOG.

Verification

  • All doc links resolve (existence-checked); code fences balanced.
  • 505 → 441 lines, 3796 → 3222 words; reading order now: hook → why → how → using it → benchmark → build → docs → roadmap → license.
  • No other docs reference the changed README sections (CONTRIBUTING/AGENTS checked) — no cross-doc drift.
  • The diff is exactly the reviewed change set; nothing else touched.

The reviewed README pass (all five changes approved):
- Drop the hard-coded version badge (stale at 1.0.0); the crates.io
  badge always shows the real latest and cannot go stale.
- Status blockquote: 10 lines of §/D references -> 3 lines; the
  feature details live in Using it, history in the CHANGELOG.
- '15 frame types' -> '17 frame types' (counted in framing.rs:
  T_DRY_RUN_ACK and the tree worker/file frames were added).
- Decision ranges: '(D1-D19)' and 'D1–D17' -> 'D1–D22' (the ledger's
  real range; the old mentions also skipped D20), dashes unified.
- Roadmap: 78 lines of release history -> 24 (one line per release
  + the 'deliberately not planned' list); the 0.4 line no longer
  misdates negation (0.7.1). Full history stays in the CHANGELOG.

Verified: all doc links resolve (existence-checked), code fences
balanced, 505 -> 441 lines / 3796 -> 3222 words. No other docs
reference the changed README sections (CONTRIBUTING/AGENTS checked).
@bennischober
bennischober merged commit 9913c03 into main Oct 24, 2026
4 checks passed
@bennischober
bennischober deleted the docs/readme-review branch October 24, 2026 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant