docs: stop the README promising evidence the default command cannot produce - #160
Merged
Merged
Conversation
…roduce The contributing section told a reader that one command reports what their installed build actually does. It does not: without --driver harness the driver falls back to reference, which answers from the vendor's documented contract and reports basis vendor-docs. evidence_report.validate() then refuses to let that claim a live basis, so a contributor following the README produced a report the project cannot accept as a witness. The command now passes --driver harness and the paragraph says what the fallback means. The quick start said install writes per-agent config into --repo. Two of the twelve adapters write into the invoking user's home instead, because that is where the vendor reads them: Junie and Kimi Code. The agent table was already honest about the paths; the prose above it was not. coverage-gaps.md multiplied the probe surface by all sixteen matrix agents. Only twelve have an adapter; the other four cannot be probed at all. The permissions paragraph listed four agents whose permission system provably exists. The data file uses that phrase for five: Junie was missing. The observability row advertised an OTel stream. The example writes JSONL and says you may feed it to OTel; nothing exports OTel. The generated examples index said Junie and Tabnine have no adapter here yet, eight lines below the table linking both of their pages. Fixed in the generator that hardcodes it and regenerated. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Claude <noreply@anthropic.com>
jothimani-rajendran
marked this pull request as ready for review
September 23, 2026 21:25
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this changes
A full audit of README.md and docs/ against the source, rather than against the last release's delta. Six findings, verified by running the code.
The contributing section promised a witness the command does not produce. It told a reader that one command "reports what your version actually does, and the result becomes a
verifiedrecord". Running it:Without
--driver harnessthe driver falls back toreference, which answers from the vendor's documented contract and never touches the contributor's installed agent.evidence_report.validate()then refuses to let that claim a live basis, so anyone following the README produced a report this project cannot accept as evidence. The command now carries the flag and the paragraph explains what the fallback is for.The quick start said
installwrites into--repo. Two of the twelve adapters write into the invoking user's home directory instead, because that is where the vendor reads them:~/.junie/config.jsonand~/.kimi-code/config.toml. The agent table below was already honest about those paths; the prose above it was not, and a reader trying the quick start in a scratch directory got two files in their home with no warning.Other corrections, each checked against the data:
vendor-source, which the grade ceiling treats as strictly strongerOne generated page was flatly wrong.
examples/generated/README.mdsaid "Junie, Replit and Tabnine have no adapter here yet", eight lines below the table linkingjunie.mdandtabnine.md. Only Replit and Copilot are adapterless. It is CI-locked, so it would never have self-corrected. Fixed in the generator that hardcodes the string and regenerated.Claim check
MATRIXrow carries averifiedrecord — no matrix row changedChecks
pytest -qpasses (1850 passed, 4 skipped)ruff check .andruff format --check .passpython examples/generate.py --checkclean after regeneratingNotes for the reviewer
The
--driver harnessfix is the one worth reading closely.CONTRIBUTING.mdalready warned about the reference driver; the README did not, and the README is where the "no code required" invitation lives.🤖 Generated with Claude Code
https://claude.ai/code/session_01CzNYfzP8ymU3r4JB9Sz8Ha
Generated by Claude Code