Documentation
¶
Overview ¶
Command docsgen renders the documentation-site guide pages from their real sources, so the site is never a second copy of the docs that can drift from the first. Two sources feed it:
- the agent skill compiled into the binary (internal/skill/assets) — the prose an AI reads before driving fft, and the best usage documentation the repo has. Its files map one-to-one onto guide pages.
- the README — the home of install, setup, authentication and CI, which the skill does not cover. docsgen slices out the sections it needs by heading.
Everything it writes is committed, and CI re-runs it and fails on a diff — the same no-drift contract make generate has. Edit a skill file or a README section and the guide page follows on the next `make docs`; rename a README heading out from under it and docsgen fails loudly rather than emitting a half-empty page.
go run ./tools/docsgen -skill internal/skill/assets -readme README.md -out docs/guide
Click to show internal directories.
Click to hide internal directories.