Vishesh 'ironeagle' Bangotra
06ffd2febd
Squash-merge lib-standardisation: adopt repo standards across packaging, tooling, docs, and CI. - standardize pyproject.toml (canonical packaging, lint config, extras, GSDFC pydoclint) - add py.typed marker, modernize type hints and Google-style docstrings - nest generated docs under docs/lib and docs/mcp; add hand-written wiki - adopt standard Type A PyPI CI pipeline (tag==version guard + quality gate) - promote generated CHANGELOG.md; bump version to 0.0.7
61 lines
1.5 KiB
Markdown
61 lines
1.5 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 (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
|
||
|
||
```bash
|
||
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
|
||
|
||
```bash
|
||
doc-forge build --mcp --module docforge
|
||
doc-forge serve --mcp --module docforge
|
||
```
|
||
|
||
---
|
||
|
||
## Related
|
||
- [03 – Conventions](03_conventions.md) · [01 – Environment](05_development/01_environment.md) |