Skip to content

docs: no version-sensitive claims in the README - #267

Open
thedavidmeister wants to merge 1 commit into
mainfrom
2026-09-21-cut-version-sensitive-readme
Open

thedavidmeister wants to merge 1 commit into
mainfrom
2026-09-21-cut-version-sensitive-readme

Conversation

@thedavidmeister

Copy link
Copy Markdown
Contributor

What

The README named soldeer versions (0.1.5, 0.1.6) and five tags to mark where the library/deploy split falls.
Owner ruling 2026-09-21: docs carry no version-sensitive claims — they rot as soon as the next release lands, and
nothing keeps them in step. The paragraph now says the same thing without a version or tag in it: pre-split releases
carried the concrete and the deploy pins, and the Protofire reports audit those rather than the current tree.

The audit issue that paragraph came from (#111) stays closed; this is the ruling applied to its wording.

QA

  • Discriminating tests: n/a - README prose, and tests never assert README text. The checks that stand in: grep -nE '0\.1\.[0-9]|sol-v|v0\.1\.' README.md returns nothing, and forge test is unchanged at 78 passing.
  • Mutations applied: n/a - no source change, no executable line in the diff.
  • Oracle: the ruling itself. What survives is the split, which is a property of the repo rather than of any release.
  • Category check: swept the repo for the same shape — CLAUDE.md, the NatSpec under src/, and .github/ carry no
    version or tag claims; audit/mutation-test-scans.json and .audit/ do, and stay, because they are records of a
    run at a commit rather than documentation.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@thedavidmeister thedavidmeister self-assigned this Sep 21, 2026
@coderabbitai

coderabbitai Bot commented Sep 21, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 51 seconds.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 1a38fb1a-1010-4fb0-9350-620725e3d0da

📥 Commits

Reviewing files that changed from the base of the PR and between 7a6cba0 and 5c80d85.

📒 Files selected for processing (1)
  • README.md

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

Comment @coderabbitai help to get the list of available commands.

This branch has not been deployed

No deployments
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