BoB Documentation
Start here
Section titled “Start here”- BoB in One Day: a full working day with BoB, morning to evening. If you read one page, read this one.
- bob CLI reference: every
bobcommand on one page, grouped by job, with every flag and exit code, plus the slash commands that do the same job inside a Claude session. - Troubleshooting: look up an error a
bobcommand printed and find its fix. - Coming back to a project: the routine for your first hour back on a project after time away.
- Release notes: what each stable release adds and fixes, and exactly what to run on every machine and in every project to take it.
Find the right doc
Section titled “Find the right doc”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 |
Fix an error a bob command printed |
Troubleshooting: look up an error | how-to |
| Look up a flag, table, or contract | Reference | reference |
| Understand why BoB works this way | Explanation | explanation |
| Operate — run a procedure step-by-step | Runbooks | how-to (ops) |
| Read exploratory notes & findings | Research | explanation (draft) |
Tutorials
Section titled “Tutorials”New to BoB? Start with the first one.
- BoB in One Day — your first full day, morning to evening: init, provision, a requirement, warp-drive, status, and the live graph. Rendered from the workday scenarios page, so its commands are the ones that ship.
- Getting Started — the short install-and-go reference: first-time install, a new or existing project, autonomous mode.
The conceptual spine
Section titled “The conceptual spine”- Vision — the product vision: why BoB exists, who it serves, where it’s going.
- A Day in the Life of a BoB Workday — one realistic developer day end-to-end, organized around the seams between commands.
- Project Orchestration Handbook — the encyclopedic narrative reference.
- Client Farms — a BoB farm in a client-owned cloud account: who owns which layer, why the farm tooling and the farm data live apart, and how it is built, updated and rebuilt.
- Prime Directive — declarative, version-controlled, idempotent, one-owner-per-fact; every conclusion on evidence and merit.
- Skill evolution — how experience becomes better skills: raw traces, a persistent wiki and executable skills kept apart, every skill change gated by an eval.
- 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 are deleted to a git tag, not kept in the tree (standard §5). - The doc-keeper auditor (
make docs-check) enforces structure: orphans, root placement, frontmatter, links.