Vishesh 'ironeagle' Bangotra
4b0fdfaf85
- Renamed `02_architecture.md` to `02_components.md` to match the standard component page naming convention.
- Updated `docs/mkdocs.wiki.yml` to reflect renamed pages and fix navigation label acronym casing (GSDFC, MCP, MkDocs).
- Updated `index.md` to include the mandatory doc model blockquote, standardize section headers with emojis, and accurately map the `Documentation Structure` table to the navigation menu.
- Standardized all wiki pages (`01_overview.md`, `02_components.md`, `03_conventions.md`, `04_iterative_workflow.md`, and `05_development/*`) by:
- Adding horizontal rules (`---`) between major sections.
- Applying emoji-prefixed H2 headings for recognizable section types.
- Appending `## Related` or `## ➡️ Read Next` footers with standard relative cross-links.
- Adjusting H1 headers to match guide anatomy (e.g., `# Library Overview` on the overview page).
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) |