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
# Library reference only
doc-forge build --mkdocs --module docforge

# Wik + library combined (single MkDocs build)
doc-forge build --wiki --mkdocs --module docforge

# Wiki only — no module required
doc-forge build --wiki --site-name docforge

What a combined 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 wiki navigation from docs/wiki/**.
  5. Writes mkdocs.yml with merged navigation — wiki first, generated groups appended, and the wiki Home replacing any spec Home entry.
  6. Runs mkdocs build once and emits the site.

Explore the site

1
2
doc-forge build --wiki --mkdocs --module docforge
doc-forge serve --mkdocs-yml mkdocs.yml