User-facing documentation. Organized by what the reader is trying to do, not by what part of the code it covers.
If you're new, read in this order:
- getting-started.md — install, init, first proposal, first approval.
- object-model.md — what Claim / Source / Page / Entity / Relation actually mean, with examples.
- review-gate.md — how the propose → approve flow works, including edge cases.
- transports.md — wiring vouch into your LLM host or into shell scripts.
- retrieval.md — how
kb.searchandkb.contextpick what to return. - bundles.md — exporting and importing KBs between repos.
- multi-agent.md — running several agents against one KB without stepping on each other.
- faq.md — questions we keep getting.
- embeddings.md — semantic retrieval (primary backend)
- gittensor.md — adopting vouch as a Gittensor repo's review-gated decision memory.
| Where | Audience |
|---|---|
README.md (root) |
newcomer, quick-pitch |
docs/ |
end users and operators |
SPEC.md + spec/ |
implementers of alternative servers, auditors |
proposals/ |
people evolving the protocol |
schemas/ |
tooling that validates artifacts |
examples/ |
learning by reading real shapes |
templates/ |
learning by copy-paste |
Docs are explainers. Spec is normative. When they disagree, the spec wins; please file an issue.