Problem
The scripts/validate-docs.sh CI check requires that README.md, CLAUDE.md, and ARCHITECTURE.md all mention the exact version from Cargo.toml. Since release-please bumps Cargo.toml automatically but not the docs, this check fails after every release.
Current state: Cargo.toml is at 0.28.2, but README.md still says 0.28.0.
Impact
validate job fails on every PR until someone manually updates the version strings in 3 docs files
- This is a false positive — the docs don't need to track the exact patch version
Proposed fix
Either:
- Remove version check from docs — don't require exact version match in README/CLAUDE.md/ARCHITECTURE.md
- Use a version placeholder — e.g.
rtk X.Y.Z and let release-please update it
- Only check major.minor — allow patch version mismatch
Option 1 is simplest and avoids future breakage.
Problem
The
scripts/validate-docs.shCI check requires that README.md, CLAUDE.md, and ARCHITECTURE.md all mention the exact version fromCargo.toml. Since release-please bumpsCargo.tomlautomatically but not the docs, this check fails after every release.Current state:
Cargo.tomlis at0.28.2, but README.md still says0.28.0.Impact
validatejob fails on every PR until someone manually updates the version strings in 3 docs filesProposed fix
Either:
rtk X.Y.Zand let release-please update itOption 1 is simplest and avoids future breakage.