About
About these docs
Where the docs live, how the reference is generated and how to change a page.
These docs live in the product repository, in docs-site/, next to the code they describe, so a change and its documentation land in the same pull request. They are built with Docus and published as static files.
Change a page
Pages are Markdown in docs-site/content/, one folder per section. Numbers in file names set the order.
Terminal
cd docs-site
npm ci
npm run dev # http://localhost:3001
Generated pages
The CLI reference is generated from the binaries' own help text. Never edit it by hand; change the command's help in Go and regenerate:
Terminal
make build
cd docs-site && npm run reference
CI regenerates it and fails if it is out of date.
Rules
- Every page answers one task. Commands can be copied and run as written.
- Pages about planned features start with a notice saying so.
- Plain words, active voice, sentence-case headings.
The project's internal documents (the plan, ADRs and the build journal) are in docs/ and are not published here.