Vishesh 'ironeagle' Bangotra
582b6809a0
- fix GSDFC spec contradictions in __init__ docstring (parenthesized types, fenced-block rule) and sync generated README - rewrite docstrings across loaders, models, nav, servers, renderers, cli; sync .pyi stubs - add pydoclint (google style) gate to dev extras and pyproject config - fix mcp nav resources doc:// -> docs:// - refresh docs/lib and docs/mcp, drop stale docforge/ duplicate group - update wiki pages and add GSDFC + MCP guides under 05_development
43 lines
1.1 KiB
Markdown
43 lines
1.1 KiB
Markdown
# Iterative Workflow
|
|
|
|
A docs build runs through the CLI in a single pass.
|
|
|
|
## Build commands
|
|
|
|
```bash
|
|
# Library reference only
|
|
doc-forge build --mkdocs --module docforge
|
|
|
|
# Wiki + library combined (single 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 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
|
|
|
|
```bash
|
|
doc-forge build --wiki --mkdocs --module docforge
|
|
doc-forge serve --mkdocs --mkdocs-yml mkdocs.yml
|
|
```
|
|
|
|
## Serve the MCP bundle
|
|
|
|
```bash
|
|
doc-forge build --mcp --module docforge
|
|
doc-forge serve --mcp --module docforge
|
|
``` |