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
42 lines
1.8 KiB
Markdown
42 lines
1.8 KiB
Markdown
# 🔨 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](01_overview.md) | What docforge is and how it fits the pipeline |
|
|
| [Architecture](02_architecture.md) | Loaders, models, nav, renderers, CLI, servers |
|
|
| [Conventions](03_conventions.md) | GSDFC, `.pyi` stubs, and template conventions |
|
|
| [Iterative Workflow](04_iterative_workflow.md) | How a docs build runs end to end |
|
|
| [Development](05_development/01_environment.md) | Environment setup and quality gates |
|
|
| [Docstring Guide](05_development/03_gsdfc_guide.md) | How to write GSDFC-conformant docstrings |
|
|
| [MCP Guide](05_development/04_mcp_guide.md) | Building, serving, and consuming the MCP bundle |
|
|
|
|
---
|
|
|
|
## 🔗 Related Resources
|
|
|
|
- **Source Code:** the `doc-forge` repository
|
|
- **Wiki Kind:** hand-written content lives in `docs/wiki/`
|
|
- **MCP Bundle:** generated by `doc-forge build --mcp --module docforge` into `docs/mcp/`
|
|
|
|
---
|
|
|
|
© Aetoskia Internal |