docs: reality-check audit of documentation-vs-code#171
Merged
Conversation
Evidence-only audit of every public-facing doc surface (README, docs/, CHANGELOG, AGENTS.md, CLAUDE.md, vscode-rivet/README.md, schemas, CLI help strings). 28 mismatches registered with claim/reality/type/ severity. Top finding: Kani/Verus/Rocq CI jobs are all continue-on-error:true but CHANGELOG claims them as "wired in". Secondary: docs/audit-report.md still says fuzz+mutation "NOT IMPLEMENTED"; docs/schemas.md documents 5 of 27 schemas; multiple hand-coded artifact counts (447/57/235+) have drifted from live regenerated AGENTS.md values. No fixes applied; separate PRs. Trace: skip
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
⚠️ Performance Alert ⚠️
Possible performance regression was detected for benchmark 'Rivet Criterion Benchmarks'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.
| Benchmark suite | Current: e476f48 | Previous: 0dbf10c | Ratio |
|---|---|---|---|
store_insert/10000 |
19768980 ns/iter (± 1711227) |
12414144 ns/iter (± 920339) |
1.59 |
link_graph_build/10000 |
42469321 ns/iter (± 4161005) |
26631897 ns/iter (± 1661262) |
1.59 |
validate/10000 |
18155613 ns/iter (± 1486308) |
11331299 ns/iter (± 718090) |
1.60 |
diff/10000 |
11046028 ns/iter (± 334938) |
7770007 ns/iter (± 161304) |
1.42 |
This comment was automatically generated by workflow using github-action-benchmark.
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
1 participant
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.
Summary
docs/design/doc-reality-audit.md.continue-on-error: true; (2)docs/audit-report.mdstill says fuzz+mutation "NOT IMPLEMENTED" though both shipped; (3)docs/schemas.mddocuments 5 schemas of 27 that actually ship.Scope
Key findings
rivet statsoutput.cargo install rivet-cli; rivet-cli is not on crates.io.Test plan
rivet stats,grep -c "#[kani::proof]",ls schemas/ | wc -l,ls fuzz/fuzz_targets/on current main.Trace: skip (docs-only audit)
🤖 Generated with Claude Code