Skip to content

Iterative Workflow

A docs build runs through the CLI in a single pass.

🚀 Build commands

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# 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

  1. Validates the requested modes (--mkdocs, --api, --wiki, --mcp).
  2. Generates library sources under docs/lib/** with MkDocsRenderer.
  3. Generates API sources under docs/api/** when --api is given.
  4. Derives the wiki navigation from docs/wiki/**.
  5. Writes one MkDocs config per site kind (docs/mkdocs.{lib,api,wiki}.yml), re-rooting navigation paths to each kind's docs_dir.
  6. Runs mkdocs build once per config, emitting self-contained sites site/lib/, site/api/, and site/wiki/.

🧭 Explore the sites

1
2
3
4
5
6
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

1
2
doc-forge build --mcp --module docforge
doc-forge serve --mcp --module docforge