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).
This commit is contained in:
@@ -20,7 +20,7 @@
|
||||
|
||||
|
||||
|
||||
<title>Mcp Guide - doc-forge</title>
|
||||
<title>MCP Guide - doc-forge</title>
|
||||
|
||||
|
||||
|
||||
@@ -106,7 +106,7 @@
|
||||
<div class="md-header__topic" data-md-component="header-topic">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Mcp Guide
|
||||
MCP Guide
|
||||
|
||||
</span>
|
||||
</div>
|
||||
@@ -224,13 +224,13 @@
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../02_architecture/" class="md-tabs__link">
|
||||
<a href="../../02_components/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Architecture
|
||||
Components
|
||||
|
||||
</a>
|
||||
</li>
|
||||
@@ -385,12 +385,12 @@
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../02_architecture/" class="md-nav__link">
|
||||
<a href="../../02_components/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Architecture
|
||||
Components
|
||||
|
||||
</span>
|
||||
|
||||
@@ -562,7 +562,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Gsdfc Guide
|
||||
GSDFC Guide
|
||||
|
||||
</span>
|
||||
|
||||
@@ -594,7 +594,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Mcp Guide
|
||||
MCP Guide
|
||||
|
||||
</span>
|
||||
|
||||
@@ -607,7 +607,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Mcp Guide
|
||||
MCP Guide
|
||||
|
||||
</span>
|
||||
|
||||
@@ -632,7 +632,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#building-the-bundle" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Building the bundle
|
||||
🚀 Building the bundle
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -641,7 +641,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#serving-the-bundle" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Serving the bundle
|
||||
🚀 Serving the bundle
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -650,7 +650,16 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#bundle-contents" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Bundle contents
|
||||
📦 Bundle contents
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#related" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Related
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -677,7 +686,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Mkdocs Configs
|
||||
MkDocs Configs
|
||||
|
||||
</span>
|
||||
|
||||
@@ -716,7 +725,8 @@
|
||||
GSDFC docstrings and serve that bundle over the Model Context Protocol (MCP).
|
||||
The bundle is self-contained: readers can derive the full API reference —
|
||||
signatures, docstrings, and structure — for the documented project.</p>
|
||||
<h2 id="building-the-bundle">Building the bundle</h2>
|
||||
<hr />
|
||||
<h2 id="building-the-bundle">🚀 Building the 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-0-1">1</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>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>
|
||||
<p>This writes structured JSON into <code>docs/mcp/</code>:</p>
|
||||
@@ -725,7 +735,8 @@ signatures, docstrings, and structure — for the documented project.</p>
|
||||
<li><code>nav.json</code> — module list with <code>docs://modules/{module}</code> resource URIs</li>
|
||||
<li><code>modules/{dotted.path}.json</code> — per-module serialized documentation</li>
|
||||
</ul>
|
||||
<h2 id="serving-the-bundle">Serving the bundle</h2>
|
||||
<hr />
|
||||
<h2 id="serving-the-bundle">🚀 Serving the 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-1-1">1</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>serve<span class="w"> </span>--mcp<span class="w"> </span>--module<span class="w"> </span>docforge
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
<p>The <code>MCPServer</code> (in <code>docforge/servers/mcp_server.py</code>) exposes:</p>
|
||||
@@ -755,7 +766,8 @@ signatures, docstrings, and structure — for the documented project.</p>
|
||||
Missing resources are returned as structured error dictionaries rather than
|
||||
exceptions. The default transport is <code>streamable-http</code>; <code>stdio</code> and <code>sse</code> are
|
||||
supported via <code>MCPServer.run</code>.</p>
|
||||
<h2 id="bundle-contents">Bundle contents</h2>
|
||||
<hr />
|
||||
<h2 id="bundle-contents">📦 Bundle contents</h2>
|
||||
<p>Each module resource contains:</p>
|
||||
<ul>
|
||||
<li><code>path</code> — dotted module path</li>
|
||||
@@ -767,6 +779,11 @@ supported via <code>MCPServer.run</code>.</p>
|
||||
equals the quality of the project's GSDFC docstrings. For docforge itself,
|
||||
the GSDFC specification is carried in <code>modules/docforge.json</code> via the
|
||||
<code>docforge/__init__.py</code> package docstring, making the bundle self-documenting.</p>
|
||||
<hr />
|
||||
<h2 id="related">Related</h2>
|
||||
<ul>
|
||||
<li><a href="../03_gsdfc_guide/">03 – GSDFC Guide</a> · <a href="../05_mkdocs_configs/">05 – MkDocs Configs</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user