aetos/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: refresh doc-forge library and MCP bundle

Browse Source 
- collect regenerated doc-forge combined site (wiki + lib)
- drop stale lib/docforge duplicate subtree
- mcp bundle now uses docs:// module resources
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-09-12 13:12:55 +05:30
parent bd8ba6e67c
commit 167d44fcfe
107 changed files with 4754 additions and 40058 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
doc-forge/wiki/01_overview/index.html
View File

@@ -314,6 +314,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#mcp-bundle" class="md-nav__link">
<span class="md-ellipsis">
MCP bundle
</span>
</a>
</li>
</ul>
@@ -403,6 +412,10 @@
@@ -487,6 +500,52 @@
<li class="md-nav__item">
<a href="../05_development/03_gsdfc_guide/" class="md-nav__link">
<span class="md-ellipsis">
Gsdfc Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../05_development/04_mcp_guide/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Guide
</span>
</a>
</li>
</ul>
</nav>
@@ -1246,6 +1305,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#mcp-bundle" class="md-nav__link">
<span class="md-ellipsis">
MCP bundle
</span>
</a>
</li>
</ul>
@@ -1295,8 +1363,8 @@ and assembles a single MkDocs site from all available material.</p>
</tr>
<tr>
<td><code>mcp</code></td>
<td>Griffe + renderers</td>
<td><code>docs/mcp/**</code> structured files</td>
<td>GSDFC docstrings + renderers</td>
<td><code>docs/mcp/**</code> structured JSON</td>
</tr>
</tbody>
</table>
@@ -1309,6 +1377,10 @@ and assembles a single MkDocs site from all available material.</p>
</ol>
<p>Hand-written wiki content is never overwritten or regenerated — only its
navigation is derived automatically.</p>
<h2 id="mcp-bundle">MCP bundle</h2>
<p><code>docs/mcp/**</code> is a self-contained, machine-readable reference generated from
docforge's own GSDFC docstrings. <code>doc-forge serve --mcp --module docforge</code>
serves it over MCP. See the <a href="../05_development/04_mcp_guide/">MCP Guide</a>.</p>

77
doc-forge/wiki/02_architecture/index.html
View File

@@ -345,6 +345,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#servers" class="md-nav__link">
<span class="md-ellipsis">
Servers
</span>
</a>
</li>
<li class="md-nav__item">
@@ -421,6 +430,10 @@
@@ -505,6 +518,52 @@
<li class="md-nav__item">
<a href="../05_development/03_gsdfc_guide/" class="md-nav__link">
<span class="md-ellipsis">
Gsdfc Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../05_development/04_mcp_guide/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Guide
</span>
</a>
</li>
</ul>
</nav>
@@ -1273,6 +1332,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#servers" class="md-nav__link">
<span class="md-ellipsis">
Servers
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1306,8 +1374,7 @@ bottom through the CLI.</p>
<h2 id="loaders-models">Loaders → Models</h2>
<p>The <code>docforge/loaders</code> package wraps <code>griffe</code> to extract modules, functions,
classes, and Google-style docstring sections. Loaded data is normalized into
the object model under <code>docforge/models</code> (<code>Module</code>, <code>Object</code>, <code>Project</code>,
<code>Field</code>).</p>
the object model under <code>docforge/models</code> (<code>Project</code>, <code>Module</code>, <code>DocObject</code>).</p>
<h2 id="navigation">Navigation</h2>
<p><code>docforge/nav</code> parses <code>docforge.nav.yml</code> specs (<code>NavSpec</code>, <code>Resolver</code>, and the
MkDocs nav emitter) and, since the wiki kind, derives wiki navigation from the
@@ -1318,6 +1385,12 @@ file structure via <code>build_wiki_nav</code>.</p>
<li><code>MkDocsRenderer</code> → <code>docs/lib/**</code> reference markdown</li>
<li><code>MCPRenderer</code> → <code>docs/mcp/**</code> structured documentation</li>
</ul>
<h2 id="servers">Servers</h2>
<p><code>docforge/servers</code> serves generated artifacts over live protocols:</p>
<ul>
<li><code>MCPServer</code> → serves a pre-generated <code>docs/mcp/**</code> bundle through MCP
resources (<code>docs://index</code>, <code>docs://nav</code>, <code>docs://modules/{module}</code>)</li>
</ul>
<h2 id="cli">CLI</h2>
<p><code>docforge/cli</code> wires it all together:</p>
<ul>

64
doc-forge/wiki/03_conventions/index.html
View File

@@ -421,6 +421,10 @@
@@ -505,6 +509,52 @@
<li class="md-nav__item">
<a href="../05_development/03_gsdfc_guide/" class="md-nav__link">
<span class="md-ellipsis">
Gsdfc Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../05_development/04_mcp_guide/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Guide
</span>
</a>
</li>
</ul>
</nav>
@@ -1305,13 +1355,25 @@
<p>All documented source uses the Google-Styled Doc-Forge Convention (GSDFC):
<code>Args:</code>, <code>Returns:</code>, <code>Raises:</code>, and <code>Attributes:</code> sections with properly typed
signatures.</p>
<p>The authoritative GSDFC specification lives in the <code>docforge/__init__.py</code>
package docstring, which is exported verbatim into
<code>docs/mcp/modules/docforge.json</code>, so the MCP bundle is self-documenting.</p>
<p>Key rules:</p>
<ul>
<li>Use parenthesized types in prose entries (<code>name (Type):</code>) that match the
signature types.</li>
<li>Use <code># Summary</code>, <code># Examples</code>, and <code># Notes</code> sections at module level.</li>
<li>Use <code>Args:</code>, <code>Returns:</code>, <code>Raises:</code>, <code>Yields:</code>, <code>Notes:</code>, and <code>Example:</code>
sections at function and method level.</li>
<li>Always update the matching <code>.pyi</code> stub alongside the <code>.py</code> implementation.</li>
</ul>
<h2 id="pyi-stubs"><code>.pyi</code> stubs</h2>
<p>Every module ships a matching <code>.pyi</code> stub kept in sync with the <code>.py</code>
implementation. When signatures change, update both files.</p>
<h2 id="wiki-pages">Wiki pages</h2>
<ul>
<li>Hand-written markdown lives in <code>docs/wiki/**</code> and is never generated.</li>
<li>File names use a numeric prefix: <code>01_overview.md</code>, <code>02_components.md</code>.</li>
<li>File names use a numeric prefix: <code>01_overview.md</code>, <code>02_architecture.md</code>.</li>
<li>Nested directories become nested navigation groups:
<code>05_development/01_environment.md</code> → group <em>Development</em>.</li>
<li><code>index.md</code> is the site <code>Home</code> at the root, and a section root inside a

99
doc-forge/wiki/04_iterative_workflow/index.html
View File

@@ -389,6 +389,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#serve-the-mcp-bundle" class="md-nav__link">
<span class="md-ellipsis">
Serve the MCP bundle
</span>
</a>
</li>
</ul>
@@ -412,6 +421,10 @@
@@ -496,6 +509,52 @@
<li class="md-nav__item">
<a href="../05_development/03_gsdfc_guide/" class="md-nav__link">
<span class="md-ellipsis">
Gsdfc Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../05_development/04_mcp_guide/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Guide
</span>
</a>
</li>
</ul>
</nav>
@@ -1264,6 +1323,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#serve-the-mcp-bundle" class="md-nav__link">
<span class="md-ellipsis">
Serve the MCP bundle
</span>
</a>
</li>
</ul>
@@ -1285,21 +1353,27 @@
<h1 id="iterative-workflow">Iterative Workflow</h1>
<p>A docs build runs through the CLI in a single pass.</p>
<h2 id="build-commands">Build commands</h2>
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span>
<span class="normal"><a href="#__codelineno-0-2">2</a></span>
<span class="normal"><a href="#__codelineno-0-3">3</a></span>
<span class="normal"><a href="#__codelineno-0-4">4</a></span>
<span class="normal"><a href="#__codelineno-0-5">5</a></span>
<span class="normal"><a href="#__codelineno-0-6">6</a></span>
<span class="normal"><a href="#__codelineno-0-7">7</a></span>
<span class="normal"><a href="#__codelineno-0-8">8</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="c1"># Library reference only</span>
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1"> 1</a></span>
<span class="normal"><a href="#__codelineno-0-2"> 2</a></span>
<span class="normal"><a href="#__codelineno-0-3"> 3</a></span>
<span class="normal"><a href="#__codelineno-0-4"> 4</a></span>
<span class="normal"><a href="#__codelineno-0-5"> 5</a></span>
<span class="normal"><a href="#__codelineno-0-6"> 6</a></span>
<span class="normal"><a href="#__codelineno-0-7"> 7</a></span>
<span class="normal"><a href="#__codelineno-0-8"> 8</a></span>
<span class="normal"><a href="#__codelineno-0-9"> 9</a></span>
<span class="normal"><a href="#__codelineno-0-10">10</a></span>
<span class="normal"><a href="#__codelineno-0-11">11</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="c1"># Library reference only</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a>doc-forge<span class="w"> </span>build<span class="w"> </span>--mkdocs<span class="w"> </span>--module<span class="w"> </span>docforge
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a><span class="c1"># Wik + library combined (single MkDocs build)</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a><span class="c1"># Wiki + library combined (single MkDocs build)</span>
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5"></a>doc-forge<span class="w"> </span>build<span class="w"> </span>--wiki<span class="w"> </span>--mkdocs<span class="w"> </span>--module<span class="w"> </span>docforge
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6"></a>
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7"></a><span class="c1"># Wiki only — no module required</span>
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8"></a>doc-forge<span class="w"> </span>build<span class="w"> </span>--wiki<span class="w"> </span>--site-name<span class="w"> </span>docforge
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9"></a>
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10"></a><span class="c1"># MCP structured bundle</span>
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11"></a>doc-forge<span class="w"> </span>build<span class="w"> </span>--mcp<span class="w"> </span>--module<span class="w"> </span>docforge
</span></code></pre></div></td></tr></table></div>
<h2 id="what-a-combined-build-does">What a combined build does</h2>
<ol>
@@ -1314,7 +1388,12 @@
<h2 id="explore-the-site">Explore the site</h2>
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-1-1">1</a></span>
<span class="normal"><a href="#__codelineno-1-2">2</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1"></a>doc-forge<span class="w"> </span>build<span class="w"> </span>--wiki<span class="w"> </span>--mkdocs<span class="w"> </span>--module<span class="w"> </span>docforge
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2"></a>doc-forge<span class="w"> </span>serve<span class="w"> </span>--mkdocs-yml<span class="w"> </span>mkdocs.yml
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2"></a>doc-forge<span class="w"> </span>serve<span class="w"> </span>--mkdocs<span class="w"> </span>--mkdocs-yml<span class="w"> </span>mkdocs.yml
</span></code></pre></div></td></tr></table></div>
<h2 id="serve-the-mcp-bundle">Serve the MCP bundle</h2>
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-2-1">1</a></span>
<span class="normal"><a href="#__codelineno-2-2">2</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1"></a>doc-forge<span class="w"> </span>build<span class="w"> </span>--mcp<span class="w"> </span>--module<span class="w"> </span>docforge
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2"></a>doc-forge<span class="w"> </span>serve<span class="w"> </span>--mcp<span class="w"> </span>--module<span class="w"> </span>docforge
</span></code></pre></div></td></tr></table></div>

53
doc-forge/wiki/05_development/01_environment/index.html
View File

@@ -343,6 +343,10 @@
@@ -487,6 +491,52 @@
<li class="md-nav__item">
<a href="../03_gsdfc_guide/" class="md-nav__link">
<span class="md-ellipsis">
Gsdfc Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../04_mcp_guide/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Guide
</span>
</a>
</li>
</ul>
</nav>
@@ -1272,7 +1322,7 @@
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a>.venv<span class="se">\S</span>cripts<span class="se">\a</span>ctivate
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
</span></code></pre></div></td></tr></table></div>
<p>Requires Python 3.11+.</p>
<p>Requires Python 3.10+ (per <code>pyproject.toml</code>).</p>
<h2 id="dependencies">Dependencies</h2>
<p>Development extras include:</p>
<ul>
@@ -1280,6 +1330,7 @@
<li><code>ruff</code> — lint and format checking</li>
<li><code>black</code> — auto-formatting</li>
<li><code>mypy</code> — strict typing checks</li>
<li><code>pydoclint</code> — docstring ↔ signature consistency checks</li>
</ul>

56
doc-forge/wiki/05_development/02_quality_gates/index.html
View File

@@ -12,7 +12,7 @@
<link rel="prev" href="../01_environment/">
<link rel="next" href="../../../lib/loaders/">
<link rel="next" href="../03_gsdfc_guide/">
<link rel="icon" href="../../../assets/images/favicon.png">
@@ -343,6 +343,10 @@
@@ -478,6 +482,52 @@
<li class="md-nav__item">
<a href="../03_gsdfc_guide/" class="md-nav__link">
<span class="md-ellipsis">
Gsdfc Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../04_mcp_guide/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Guide
</span>
</a>
</li>
</ul>
</nav>
@@ -1251,10 +1301,12 @@
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span>
<span class="normal"><a href="#__codelineno-0-2">2</a></span>
<span class="normal"><a href="#__codelineno-0-3">3</a></span>
<span class="normal"><a href="#__codelineno-0-4">4</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a>.venv<span class="se">\S</span>cripts<span class="se">\p</span>ython.exe<span class="w"> </span>-m<span class="w"> </span>pytest
<span class="normal"><a href="#__codelineno-0-4">4</a></span>
<span class="normal"><a href="#__codelineno-0-5">5</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a>.venv<span class="se">\S</span>cripts<span class="se">\p</span>ython.exe<span class="w"> </span>-m<span class="w"> </span>pytest
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a>.venv<span class="se">\S</span>cripts<span class="se">\p</span>ython.exe<span class="w"> </span>-m<span class="w"> </span>ruff<span class="w"> </span>check<span class="w"> </span>docforge<span class="w"> </span>tests
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a>.venv<span class="se">\S</span>cripts<span class="se">\p</span>ython.exe<span class="w"> </span>-m<span class="w"> </span>black<span class="w"> </span>--check<span class="w"> </span>docforge<span class="w"> </span>tests
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a>.venv<span class="se">\S</span>cripts<span class="se">\p</span>ython.exe<span class="w"> </span>-m<span class="w"> </span>mypy<span class="w"> </span>docforge
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5"></a>.venv<span class="se">\S</span>cripts<span class="se">\p</span>ydoclint.exe<span class="w"> </span>docforge
</span></code></pre></div></td></tr></table></div>
<h2 id="test-layout">Test layout</h2>
<table>

1609
doc-forge/wiki/05_development/03_gsdfc_guide/index.html Normal file
View File

File diff suppressed because it is too large Load Diff

1454
doc-forge/wiki/05_development/04_mcp_guide/index.html Normal file
View File

File diff suppressed because it is too large Load Diff

63
doc-forge/wiki/index.html
View File

@@ -410,6 +410,10 @@
@@ -494,6 +498,52 @@
<li class="md-nav__item">
<a href="05_development/03_gsdfc_guide/" class="md-nav__link">
<span class="md-ellipsis">
Gsdfc Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="05_development/04_mcp_guide/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Guide
</span>
</a>
</li>
</ul>
</nav>
@@ -1310,7 +1360,7 @@ OpenAPI-based API docs.</p>
</tr>
<tr>
<td><a href="02_architecture/">Architecture</a></td>
<td>Loaders, models, nav, renderers, CLI</td>
<td>Loaders, models, nav, renderers, CLI, servers</td>
</tr>
<tr>
<td><a href="03_conventions/">Conventions</a></td>
@@ -1324,13 +1374,22 @@ OpenAPI-based API docs.</p>
<td><a href="05_development/01_environment/">Development</a></td>
<td>Environment setup and quality gates</td>
</tr>
<tr>
<td><a href="05_development/03_gsdfc_guide/">Docstring Guide</a></td>
<td>How to write GSDFC-conformant docstrings</td>
</tr>
<tr>
<td><a href="05_development/04_mcp_guide/">MCP Guide</a></td>
<td>Building, serving, and consuming the MCP bundle</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="related-resources">🔗 Related Resources</h2>
<ul>
<li><strong>Source Code:</strong> <code>C:\Users\vishe\WorkSpace\code\aetos\doc-forge</code></li>
<li><strong>Source Code:</strong> the <code>doc-forge</code> repository</li>
<li><strong>Wiki Kind:</strong> hand-written content lives in <code>docs/wiki/</code></li>
<li><strong>MCP Bundle:</strong> generated by <code>doc-forge build --mcp --module docforge</code> into <code>docs/mcp/</code></li>
</ul>
<hr />
<p>© Aetoskia Internal</p>