Documentation

The docs live next to the code.

There is no separate documentation site to drift out of date. Every document below is a file in the tree, versioned with the service it describes. One of them is currently marked stale, which is the point of saying so here.

  1. 01Deployment runbookContainer images for each service, the public/private compose split, TLS and CSP templates, and the mTLS certificate tooling. Start here if you intend to run Verity yourself.docs/DEPLOY.md
  2. 02StatusWhat is verified, what is in flight, and which test gates were green at the last snapshot. Written to be checked, not to reassure.docs/STATUS.md
  3. 03Competitor gap auditVerity measured against the strongest comparable products, with a file-and-line citation behind every claim about Verity and a severity on every gap. Includes the places Verity is behind.docs/COMPETITOR_GAPS.md
  4. 04Gap closure planThe ranked sequencing of that audit: owner service, effort, dependencies.docs/COMPETITOR_GAPS_PLAN.md
  5. 05Codebase auditA point-in-time read of the tree: what exists, what is stubbed, what the tests actually cover.docs/AUDIT_2026-07-25.md
  6. 06Master planThe milestone structure the build follows, and the design rules the interface is held to.docs/MASTER_PLAN.md
  7. 07Scale backlogProduction hardening and scale-out work that is known, scoped and deliberately not done yet.docs/SCALE_BACKLOG.md
  8. 08API surfacestaleThe service and route inventory. Read it with care: the gap audit flags this file as stale, listing shipped routes as planned. The code is the authority.docs/API_SURFACE.md

BoundDocumentation is not the specification. Where a document and the source disagree, the source is right and the document is a bug, which is why the gap audit refuses to cite anything but file:line.

Read the tests, not the pitch.

The fastest honest description of what Verity does is its test suite. Everything else on this site is downstream of it.