ferraus docs build-site
Generate the mdBook docs site source from the command definitions
Synopsis
ferraus docs build-site [options]
What it does
Generate the mdBook docs site source from the command definitions
Examples
Write the docs site source
ferraus docs build-site --out target/docs-site
Fail if any command lacks examples or help text
ferraus docs build-site --check
Check the depth bar and write the site with guides from a custom folder
ferraus docs build-site --guides docs/guides --out site --check
Options
| Flag | Type | Default | Meaning |
|---|---|---|---|
--out | path | target/docs-site | Directory to write book.toml and src/ into |
--guides | path | docs/guides | Directory of hand-written guides copied into the site |
--check | flag | — | Fail when any command is below the documentation depth bar |
Global options
Every command also accepts the global options (-o, --json, --dry-run, --overwrite, --progress, ...). See Global options.
Exit codes
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | Processing failed |
| 2 | Usage or parameter error |
| 3 | Input missing or unreadable |
| 8 | Cancelled |
| 70 | Internal error (bug) |
Common mistakes
- Expecting human-readable text when scripting: add
--jsonfor a stable machine result.
For models
- MCP tool:
ferraus_docs_build_site - Schema:
ferraus schema docs build-site - Pipeline:
{ op: docs build-site, args: { ... } }(flag names with_instead of-) - fx stage: no
{"command": "docs build-site", "defaults": {"out": "target/docs-site", "guides": "docs/guides"}}