docs(examples): community example — vouchdev/vouch issue-tracker audit#358
Open
jonathanchang31 wants to merge 2 commits into
Open
docs(examples): community example — vouchdev/vouch issue-tracker audit#358jonathanchang31 wants to merge 2 commits into
jonathanchang31 wants to merge 2 commits into
Conversation
Adds examples/community/vouch-issue-tracker-audit/, a real vouch KB built by cross-referencing every open issue on vouchdev/vouch against upstream/main and upstream/test for a resolving commit. 13 of the 93 open issues checked turned out to be already fixed but left open on GitHub, or genuinely open and unclaimed; one (vouchdev#168, cross-agent approval bypassing the review gate) is still unfixed and security-relevant, with a prior maintainer review on record describing exactly what a correct fix needs. A 14th finding, a real bug in `vouch source add --url`, surfaced while building the KB itself. Every claim is proposed and approved through the real CLI and cited to a source file containing the actual evidence (git log output, direct code reads, or a maintainer's PR review comment) — no hand-authored artifacts. Closes vouchdev#338.
github-actions
Bot
added
the
docs
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
✅ Files skipped from review due to trivial changes (5)
📝 WalkthroughWalkthroughThis PR adds a new community example knowledge base, ChangesCommunity Example KB Addition
Estimated code review effort: 2 (Simple) | ~15 minutes Possibly related issues
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@examples/community/vouch-issue-tracker-audit/README.md`:
- Around line 11-18: The scope description in the README is overstated and
conflicts with the later exclusion of issues already claimed by another PR.
Update the “What it’s used for” text to describe only the in-scope issues
actually audited, and keep the wording consistent with the surrounding audit
summary in this README so it no longer implies every open issue was checked.
In
`@examples/community/vouch-issue-tracker-audit/vouch/pages/vouchdev-vouch-open-issue-tracker-audit-2026-07-04-rev-2-14-.md`:
- Around line 30-35: Update the scope statement and summary in the vouch
issue-tracker audit markdown so they accurately reflect the reviewed set:
replace the “Every open issue” wording with language that explicitly excludes
issues already tied to in-flight PRs, and correct the summary count from “11 of
these 13 issues” to “10 of these 13 issues.” Use the existing audit narrative in
the document to locate the affected summary paragraph and scope description.
In
`@examples/community/vouch-issue-tracker-audit/vouch/pages/vouchdev-vouch-open-issue-tracker-audit-2026-07-04.md`:
- Around line 54-60: Update the issue-count summary in the audit markdown so it
matches the reviewer’s breakdown: the sentence in the Vouch open issue tracker
audit should say “9 of these 13 issues” instead of “11 of these 13 issues,” and
keep the surrounding explanation consistent with the statuses of `#54`, `#100`,
`#189`, and `#168`.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: dfcf62d4-52b2-4a82-a88d-39245f2b8c0b
⛔ Files ignored due to path filters (4)
docs/img/examples/community/audit-log.svgis excluded by!**/*.svgdocs/img/examples/community/audit-search.svgis excluded by!**/*.svgdocs/img/examples/community/audit-show.svgis excluded by!**/*.svgdocs/img/examples/community/audit-status.svgis excluded by!**/*.svg
📒 Files selected for processing (83)
CHANGELOG.mdexamples/README.mdexamples/community/vouch-issue-tracker-audit/README.mdexamples/community/vouch-issue-tracker-audit/vouch/audit.log.jsonlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouch-starter-reviewed-knowledge.yamlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouchdev-vouch-issue-100-feat-richer-scopes-on-claim-source-.yamlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouchdev-vouch-issue-166-bundle-import-can-overwrite-the-aud.yamlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouchdev-vouch-issue-168-critical-agent-transport-allows-cro.yamlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouchdev-vouch-issue-189-richer-scopes-on-claim-source-per-v.yamlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouchdev-vouch-issue-54-epic-make-vouch-friendlier-and-more-.yamlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouchdev-vouch-issue-76-crystallize-bypasses-the-review-gate.yamlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouchdev-vouch-issue-78-kb-context-returns-archived-supersed.yamlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouchdev-vouch-issue-80-import-check-accepts-bundles-whose-m.yamlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouchdev-vouch-issue-81-claim-model-has-no-min-evidence-vali.yamlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouchdev-vouch-issue-92-retrieve-ignores-retrieval-backends-.yamlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouchdev-vouch-issue-93-feat-vouch-approve-batch-for-scripta.yamlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouchdev-vouch-issue-94-feat-http-transport-for-vouch-serve-.yamlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouchdev-vouch-issue-95-vouch-serve-should-fail-clearly-when.yamlexamples/community/vouch-issue-tracker-audit/vouch/claims/vouchdev-vouch-s-cli-vouch-source-add-path-url-url-silently-.yamlexamples/community/vouch-issue-tracker-audit/vouch/config.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061029-8ae22018.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061032-e2c77208.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061036-8e0faea0.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061040-ef56c928.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061043-57bfb8a4.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061047-bf405cfc.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061052-7c202c7a.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061056-e8724ce8.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061100-29c5dca4.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061106-eb27e9fd.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061110-f4c09773.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061116-082830a4.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061119-0680e882.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061425-808652d7.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061428-2ecdb562.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061432-51a7ca63.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061435-44efb4a8.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061438-7249c426.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061441-f33ed406.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061445-267a62ab.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061448-9e9bb439.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061454-49cfcfc0.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061500-9c95a168.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061505-a91c3897.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061511-995c6f4d.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061515-0e132b51.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-061640-20537c0f.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-062209-21e9b7a4.yamlexamples/community/vouch-issue-tracker-audit/vouch/decided/20260704-062448-4d9f894f.yamlexamples/community/vouch-issue-tracker-audit/vouch/pages/edit-in-obsidian.mdexamples/community/vouch-issue-tracker-audit/vouch/pages/vouchdev-vouch-open-issue-tracker-audit-2026-07-04-rev-2-14-.mdexamples/community/vouch-issue-tracker-audit/vouch/pages/vouchdev-vouch-open-issue-tracker-audit-2026-07-04.mdexamples/community/vouch-issue-tracker-audit/vouch/schema_versionexamples/community/vouch-issue-tracker-audit/vouch/sources/14ec6e206005e19431aec8e26d7f44935c4e031c535c9848c80ff9e88df13ecd/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/14ec6e206005e19431aec8e26d7f44935c4e031c535c9848c80ff9e88df13ecd/meta.yamlexamples/community/vouch-issue-tracker-audit/vouch/sources/2bea22cff37e6643e7da2782beb45db5dbe3b7a696343304f40a4485143b2025/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/2bea22cff37e6643e7da2782beb45db5dbe3b7a696343304f40a4485143b2025/meta.yamlexamples/community/vouch-issue-tracker-audit/vouch/sources/31b58bbcf6f59d6531522d2cdcd9ef5432454c657f0e4ec18ca6160ff8384a98/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/31b58bbcf6f59d6531522d2cdcd9ef5432454c657f0e4ec18ca6160ff8384a98/meta.yamlexamples/community/vouch-issue-tracker-audit/vouch/sources/4a3d84936c35017a12be0b04d8b80c5d4927d76639a75ff1dfa54dc29d66297a/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/4a3d84936c35017a12be0b04d8b80c5d4927d76639a75ff1dfa54dc29d66297a/meta.yamlexamples/community/vouch-issue-tracker-audit/vouch/sources/77cf22c12729473bdd16015f273b9b7159500a6529a43e9f61910615e9fcc5dc/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/77cf22c12729473bdd16015f273b9b7159500a6529a43e9f61910615e9fcc5dc/meta.yamlexamples/community/vouch-issue-tracker-audit/vouch/sources/9e25d14157633c926abbd0cafd1cfff119d21ad266152b7b7e49d7288b77b292/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/9e25d14157633c926abbd0cafd1cfff119d21ad266152b7b7e49d7288b77b292/meta.yamlexamples/community/vouch-issue-tracker-audit/vouch/sources/be7aec64b0fc803a33cb3d610f67ae95e636877db20231ef72440a7cbe6b69d2/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/be7aec64b0fc803a33cb3d610f67ae95e636877db20231ef72440a7cbe6b69d2/meta.yamlexamples/community/vouch-issue-tracker-audit/vouch/sources/c295fcf5b9d4f52a91667e3b65f9fd242b760401df36fb88b0a6ba9fb7a0e424/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/c295fcf5b9d4f52a91667e3b65f9fd242b760401df36fb88b0a6ba9fb7a0e424/meta.yamlexamples/community/vouch-issue-tracker-audit/vouch/sources/c59241dc3b461093c45b9d45f9aaea8ee8914f621d0fcd6cb744583fd486c0c7/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/c59241dc3b461093c45b9d45f9aaea8ee8914f621d0fcd6cb744583fd486c0c7/meta.yamlexamples/community/vouch-issue-tracker-audit/vouch/sources/dc52816569f0823843ea7f60a3ae8fdaf64fdc0c7fe66c0d892ca388a8470b50/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/dc52816569f0823843ea7f60a3ae8fdaf64fdc0c7fe66c0d892ca388a8470b50/meta.yamlexamples/community/vouch-issue-tracker-audit/vouch/sources/e55c1e956d0b08b2244e59290f01e29d2b51b8873a328bf4d5475873fb3e326d/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/e55c1e956d0b08b2244e59290f01e29d2b51b8873a328bf4d5475873fb3e326d/meta.yamlexamples/community/vouch-issue-tracker-audit/vouch/sources/efb2f2cf4f7a0e2f98ef9fb6fc1734833ec1348be50bcb81a81bc8b677a11e27/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/efb2f2cf4f7a0e2f98ef9fb6fc1734833ec1348be50bcb81a81bc8b677a11e27/meta.yamlexamples/community/vouch-issue-tracker-audit/vouch/sources/f1d74de94468e031b9eb88b781d69d16c71797a64b7da1bf39fd43e30aab2068/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/f1d74de94468e031b9eb88b781d69d16c71797a64b7da1bf39fd43e30aab2068/meta.yamlexamples/community/vouch-issue-tracker-audit/vouch/sources/f549fefbc32557f0f4b55ba774968ba5e4f4296022d49ac0fd2974467d2605c7/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/f549fefbc32557f0f4b55ba774968ba5e4f4296022d49ac0fd2974467d2605c7/meta.yamlexamples/community/vouch-issue-tracker-audit/vouch/sources/f92712389e056618ad749331fc6ad4bf756fc2a53918af2ea8de1d6754c03eb3/contentexamples/community/vouch-issue-tracker-audit/vouch/sources/f92712389e056618ad749331fc6ad4bf756fc2a53918af2ea8de1d6754c03eb3/meta.yaml
Comment on lines
+30
to
+35
| Every open issue in `vouchdev/vouch` (93 at audit time) was cross-referenced | ||
| against `git log --grep` on `upstream/main` and `upstream/test` for a commit | ||
| mentioning that issue number, then spot-checked by reading the relevant | ||
| source file directly (not just trusting the commit message). Issues already | ||
| linked from an in-flight open PR were excluded up front, since those aren't | ||
| stale — they're just not merged yet. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
file='examples/community/vouch-issue-tracker-audit/vouch/pages/vouchdev-vouch-open-issue-tracker-audit-2026-07-04-rev-2-14-.md'
echo '## Context around lines 1-80'
cat -n "$file" | sed -n '1,80p'
echo
echo '## Search for the 11-of-13 / 10-of-13 summary wording'
rg -n '11 of these 13|10 of these 13|Every open issue|All open issues|PR-linked|in-flight open PR|stale|issue tracker count' "$file"Repository: vouchdev/vouch
Length of output: 5752
Align the scope statement and summary count.
Every open issueis overstated here because PR-linked issues were excluded up front; useall open issues except those already tied to in-flight PRs.- The summary should say
10 of these 13 issues, not11 of these 13.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In
`@examples/community/vouch-issue-tracker-audit/vouch/pages/vouchdev-vouch-open-issue-tracker-audit-2026-07-04-rev-2-14-.md`
around lines 30 - 35, Update the scope statement and summary in the vouch
issue-tracker audit markdown so they accurately reflect the reviewed set:
replace the “Every open issue” wording with language that explicitly excludes
issues already tied to in-flight PRs, and correct the summary count from “11 of
these 13 issues” to “10 of these 13 issues.” Use the existing audit narrative in
the document to locate the affected summary paragraph and scope description.
Addresses CodeRabbit's review on PR vouchdev#358: - The README and both audit pages said "every open issue" was checked, which contradicted the very next sentence excluding issues already tied to another open PR. Reworded to state the actual in-scope set: 61 of 93 open issues, i.e. all except those already claimed by an in-flight PR. - The "11 of these 13 issues ... already resolved" summary double-counted vouchdev#54 and vouchdev#100 as fully fixed. vouchdev#54's epic only shipped one of several tracks, and vouchdev#100 only drafted a VEP document without building the feature it describes. Corrected to "9 of these 13", with vouchdev#54 and vouchdev#100 now called out explicitly as partial, alongside the already-separate vouchdev#189 (open) and vouchdev#168 (unfixed) callouts. The corresponding decided/ proposal records are updated to match the corrected page text, so the audit trail stays internally consistent (payload.body in decided/ mirrors the durable pages/*.md content, per `vouch doctor`/`fsck`).
Contributor
Author
|
Addressed all three CodeRabbit comments in 86c0970:
Full |
Contributor
Author
|
@plind-junior Long time no see. Could you plz review my PR? |
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
Adds
examples/community/vouch-issue-tracker-audit/, a realvouchKB built by checking every open issue in this repo againstmain/testfor a commit that already resolves it. Result: 11 issues already fixed but left open on GitHub, 1 genuinely open and unclaimed (#189), 1 still-unfixed security bug (#168, cross-agent approval bypass), and a 14th self-found bug invouch source add --urldiscovered while building the KB. Addresses issue #338.Related Isssue
Closes: #338
Change Type
Real Behavior Proof
$ cp -r examples/community/vouch-issue-tracker-audit/vouch ./.vouch
$ vouch reindex
reindex: FTS5 rebuilt
$ vouch doctor
{'claims': 15, 'pages': 3, 'sources': 15, 'pending_proposals': 0, 'audit_events': 92, 'index_present': True}
$ vouch lint
clean
$ vouch fsck
clean
Checklist
doctor/lint/fsckclean, in place and from a fresh copyexamples/README.mdCHANGELOG.mdpytestsuite greenmake lintcleanSummary by CodeRabbit