aetos/doc-forge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
8c6c46caf2a3c97d6fd36ac543886005c5678a15
doc-forge/docs/wiki/index.md
Vishesh 'ironeagle' Bangotra 8c6c46caf2 feat: add wiki build kind with file-structure-derived navigation 
- add build_wiki_nav deriving MkDocs nav from docs/wiki file structure
  (index.md -> Home, numeric prefixes stripped and title-cased, nested
  dirs become groups, natural ordering)
- add --wiki / --wiki-dir to build; wiki-only builds need no --module
- merge wiki nav before generated lib/api nav; wiki Home replaces the
  nav spec Home entry
- add mkdocs.wiki.yml template fragment and nav/cli tests
- dogfood doc-forge's own docs/wiki and regenerate site output
2026-09-11 23:38:23 +05:30

1.5 KiB
Raw Blame History

🔨 docforge — Docstring-Driven Documentation Forge

docforge is an internal documentation tool that generates reference documentation from Google-Styled Doc-Forge Convention (GSDFC) docstrings and assembles it into a single MkDocs site, alongside hand-written wiki pages and OpenAPI-based API docs.

🚀 Key Features

  • 🧪 GSDFC docstring extraction via Griffe
  • 🧭 Auto-derived navigation for hand-written wiki pages
  • 🗂 Combined MkDocs build: wiki first, then generated library/API reference
  • 🔌 Material MkDocs theming out of the box
  • 📦 MCP structured documentation resources

📁 Documentation Structure

Section Description
Overview What docforge is and how it fits the pipeline
Architecture Loaders, models, nav, renderers, CLI
Conventions GSDFC, .pyi stubs, and template conventions
Iterative Workflow How a docs build runs end to end
Development Environment setup and quality gates

🔗 Related Resources

  • Source Code: C:\Users\vishe\WorkSpace\code\aetos\doc-forge
  • Wiki Kind: hand-written content lives in docs/wiki/

© Aetoskia Internal