1.3 KiB
1.3 KiB
Iterative Workflow
A docs build runs through the CLI in a single pass.
Build commands
# Library reference only
doc-forge build --mkdocs --module docforge
# Wiki + library (each an independent MkDocs build)
doc-forge build --wiki --mkdocs --module docforge
# Wiki only — no module required
doc-forge build --wiki --site-name docforge
# MCP structured bundle
doc-forge build --mcp --module docforge
What a build does
- Validates the requested modes (
--mkdocs,--api,--wiki,--mcp). - Generates library sources under
docs/lib/**withMkDocsRenderer. - Generates API sources under
docs/api/**when--apiis given. - Derives the wiki navigation from
docs/wiki/**. - Writes one MkDocs config per site kind (
docs/mkdocs.{lib,api,wiki}.yml), re-rooting navigation paths to each kind'sdocs_dir. - Runs
mkdocs buildonce per config, emitting self-contained sitessite/lib/,site/api/, andsite/wiki/.
Explore the sites
doc-forge build --wiki --mkdocs --module docforge
doc-forge serve --wiki # serves site preview from docs/mkdocs.wiki.yml
doc-forge serve --lib
doc-forge serve --api
# or target any config directly:
doc-forge serve --mkdocs --mkdocs-yml docs/mkdocs.wiki.yml
Serve the MCP bundle
doc-forge build --mcp --module docforge
doc-forge serve --mcp --module docforge