Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ All notable changes to vouch are documented here. Format follows

## [Unreleased]

### Added
- `examples/community/vouch-issue-tracker-audit/`: a community example KB
(issue #338) auditing vouchdev/vouch's own open-issue tracker for
staleness — which open issues are already fixed upstream and which are
genuinely open, plus one live security bug (#168) and one bug in `vouch
source add --url` found while building the KB.

## [1.1.0] — 2026-07-03

### Added
Expand Down
20 changes: 20 additions & 0 deletions docs/img/examples/community/audit-log.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions docs/img/examples/community/audit-search.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions docs/img/examples/community/audit-show.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/img/examples/community/audit-status.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,17 @@ The snapshot KBs ship with everything already in `claims/`, `pages/`,
etc. — they're "post-approval" snapshots. There are no `proposed/`
entries because proposals are local-only by nature.

## Community examples

Real vouch KBs from real use, submitted per [issue #338](https://github.com/vouchdev/vouch/issues/338).
Unlike the shipped snapshots above, these aren't required to be
byte-for-byte re-renderable — just honest: every claim traceable through
`audit.log.jsonl` to an actual `propose → approve` decision.

| Example | Topic | Size |
|---|---|---|
| [community/vouch-issue-tracker-audit/](community/vouch-issue-tracker-audit/) | A codebase-hygiene audit of vouchdev/vouch's own open-issue tracker — which open issues are already fixed upstream, which are genuinely open, and one live security bug found along the way | 15 claims, 3 pages, 15 sources |

## Runnable flows

Each of these is a script that builds a throwaway KB in `$(mktemp -d)`,
Expand Down
69 changes: 69 additions & 0 deletions examples/community/vouch-issue-tracker-audit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# vouch-issue-tracker-audit/

A real `vouch` knowledge base built while auditing `vouchdev/vouch`'s own
GitHub issue tracker for staleness. It's a "codebase-audit" style KB
(findings → claims, cited to evidence) rather than a project's living
documentation, submitted for issue [#338](https://github.com/vouchdev/vouch/issues/338).

- **Host:** Claude Code, driving the real `vouch` CLI (v1.1.0) directly —
`vouch init`, `vouch source add`, `vouch propose-claim`, `vouch approve`,
`vouch propose-page`, `vouch reindex`, `vouch doctor`.
- **What it's used for:** every open issue on `vouchdev/vouch` not already
linked from another in-flight open PR (61 of 93 open issues at audit time)
was checked against `git log --grep` on `upstream/main` and `upstream/test`
for a commit resolving it, then spot-checked by reading the relevant source
directly. 13 of the resulting findings are proposed claims,
each cited to a source file containing the real evidence (a `git log`
transcript, a code excerpt, or an actual maintainer PR-review comment
copied from GitHub). A 14th finding — a real bug in `vouch source add
--url` — surfaced while building this very KB and is included too.

## What to look at first

1. [vouch/pages/vouchdev-vouch-open-issue-tracker-audit-2026-07-04-rev-2-14-.md](vouch/pages/vouchdev-vouch-open-issue-tracker-audit-2026-07-04-rev-2-14-.md) —
the findings table and method, current revision.
2. [vouch/claims/vouchdev-vouch-issue-168-critical-agent-transport-allows-cro.yaml](vouch/claims/vouchdev-vouch-issue-168-critical-agent-transport-allows-cro.yaml) —
the one still-unfixed, security-relevant finding, with a maintainer's
review notes on record from a prior closed PR.
3. [vouch/claims/vouchdev-vouch-s-cli-vouch-source-add-path-url-url-silently-.yaml](vouch/claims/vouchdev-vouch-s-cli-vouch-source-add-path-url-url-silently-.yaml) —
the self-found bug in the tool used to build this KB.
4. [vouch/audit.log.jsonl](vouch/audit.log.jsonl) — the full trail: 13
claims proposed, all 13 first rejected (wrong `--type` value), all 13
resubmitted correctly and approved, a summary page approved, a 14th claim
added, and a revised page approved. Nothing here was hand-written into
`claims/` or `decided/` directly — every artifact went through
`propose-* → approve`/`reject`.

## See it in action

After `cp -r examples/community/vouch-issue-tracker-audit/vouch ./.vouch &&
vouch reindex`, here's what the CLI shows against this KB:

`vouch status` — artifact counts and the audit-event total:

<img src="../../../docs/img/examples/community/audit-status.svg" alt="vouch status on the issue-tracker-audit example" width="620">

`vouch search cross-agent` — retrieval surfacing the live #168 finding:

<img src="../../../docs/img/examples/community/audit-search.svg" alt="vouch search cross-agent on the issue-tracker-audit example" width="760">

`vouch show` on the #168 finding's decided proposal — full citation,
rationale, and decision metadata:

<img src="../../../docs/img/examples/community/audit-show.svg" alt="vouch show on the issue-tracker-audit example" width="860">

`vouch audit --tail 10` — the reject-then-rework and page-revision trail:

<img src="../../../docs/img/examples/community/audit-log.svg" alt="vouch audit tail on the issue-tracker-audit example" width="900">

## What this example is *not*

- Not a teaching fixture — every claim, source, and audit event here is the
byproduct of a real `vouch` session, not hand-authored YAML.
- Not exhaustive — the audit covered issues without an in-flight open PR;
issues already claimed by another contributor's PR were excluded up front
rather than re-checked.
- Not a fix for #168 or the `source add --url` bug — this KB documents them
as findings with enough evidence for someone (possibly the same
contributor, in a follow-up PR) to act on. Bundling a code fix into this
PR would violate `CONTRIBUTING.md`'s "one concern per PR."
Loading
Loading