Files

Vishesh 'ironeagle' Bangotra 4b0fdfaf85 docs(wiki): align wiki structure with Aetoskia AGENTS.md guidelines

- 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).

2026-09-14 23:30:45 +05:30

1.6 KiB

Raw Blame History

Library Overview

docforge turns GSDFC-compliant Python docstrings into maintainable reference documentation. It never edits source docstrings; it reads them, renders them, and assembles documentation sites from all available material.

🧭 Which Build Should You Use?

Kind	Source	Output
`lib`	GSDFC docstrings	`docs/lib/**` rendered markdown
`api`	OpenAPI JSON spec	`docs/api/**` rendered markdown
`wiki`	Hand-written markdown	`docs/wiki/**` (unchanged)
`mcp`	GSDFC docstrings + renderers	`docs/mcp/**` structured JSON

🏗️ Architecture

Each enabled site kind produces its own MkDocs configuration and build:

--mkdocs (lib) writes docs/mkdocs.lib.yml and builds site/lib/.
--api writes docs/mkdocs.api.yml and builds site/api/.
--wiki writes docs/mkdocs.wiki.yml and builds site/wiki/.

Every site is self-contained (own theme assets and search index) with navigation derived or scoped to that kind. Hand-written wiki content is never overwritten or regenerated — only its navigation is derived automatically.

🔄 Lifecycle Rules

docs/mcp/** is a self-contained, machine-readable reference generated from docforge's own GSDFC docstrings. doc-forge serve --mcp --module docforge serves it over MCP. See the MCP Guide.

➡️ Read Next

02 – Components · 03 – Conventions

1.6 KiB Raw Blame History Unescape Escape