BoB Documentation
Start here. BoB’s docs are organized by Diátaxis mode — what you’re doing when you open a doc decides where it lives. Pick the category that matches your need.
| If you want to… | Go to | Mode |
|---|---|---|
| Learn BoB start-to-finish | Tutorials | tutorial |
| Do a specific task | How-to guides | how-to |
| Look up a flag, table, or contract | Reference | reference |
| Understand why BoB works this way | Explanation | explanation |
| Read exploratory notes & findings | Research | explanation (draft) |
The conceptual spine
Section titled “The conceptual spine”- Vision — the product vision: why BoB exists, who it serves, where it’s going.
- Project Orchestration Handbook — the encyclopedic narrative reference.
- Prime Directive — declarative, version-controlled, idempotent, one-owner-per-fact.
- Documentation Standard — the spec every doc here obeys (the governance tooling enforces it).
Conventions
Section titled “Conventions”- Every doc carries a frontmatter contract (
type/owner/last_reviewed) and serves exactly one mode. - Dated, frozen analyses live in
audits/; retired docs inarchive/(out of the live IA). - The doc-keeper auditor (
make docs-check) enforces structure: orphans, root placement, frontmatter, links.