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:
@@ -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>
|
||||
|
||||
@@ -481,7 +481,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#build-commands" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Build commands
|
||||
🚀 Build commands
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -490,7 +490,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#what-a-build-does" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
What a build does
|
||||
🔄 What a build does
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -499,7 +499,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#explore-the-sites" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Explore the sites
|
||||
🧭 Explore the sites
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -508,7 +508,16 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#serve-the-mcp-bundle" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Serve the MCP bundle
|
||||
📦 Serve the MCP bundle
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#related" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Related
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -637,7 +646,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Gsdfc Guide
|
||||
GSDFC Guide
|
||||
|
||||
</span>
|
||||
|
||||
@@ -660,7 +669,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Mcp Guide
|
||||
MCP Guide
|
||||
|
||||
</span>
|
||||
|
||||
@@ -683,7 +692,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Mkdocs Configs
|
||||
MkDocs Configs
|
||||
|
||||
</span>
|
||||
|
||||
@@ -719,7 +728,8 @@
|
||||
|
||||
<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>
|
||||
<hr />
|
||||
<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>
|
||||
@@ -742,7 +752,8 @@
|
||||
</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-build-does">What a build does</h2>
|
||||
<hr />
|
||||
<h2 id="what-a-build-does">🔄 What a build does</h2>
|
||||
<ol>
|
||||
<li>Validates the requested modes (<code>--mkdocs</code>, <code>--api</code>, <code>--wiki</code>, <code>--mcp</code>).</li>
|
||||
<li>Generates library sources under <code>docs/lib/**</code> with <code>MkDocsRenderer</code>.</li>
|
||||
@@ -753,7 +764,8 @@
|
||||
<li>Runs <code>mkdocs build</code> once per config, emitting self-contained sites
|
||||
<code>site/lib/</code>, <code>site/api/</code>, and <code>site/wiki/</code>.</li>
|
||||
</ol>
|
||||
<h2 id="explore-the-sites">Explore the sites</h2>
|
||||
<hr />
|
||||
<h2 id="explore-the-sites">🧭 Explore the sites</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>
|
||||
<span class="normal"><a href="#__codelineno-1-3">3</a></span>
|
||||
@@ -766,11 +778,17 @@
|
||||
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5"></a><span class="c1"># or target any config directly:</span>
|
||||
</span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6"></a>doc-forge<span class="w"> </span>serve<span class="w"> </span>--mkdocs<span class="w"> </span>--mkdocs-yml<span class="w"> </span>docs/mkdocs.wiki.yml
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
<h2 id="serve-the-mcp-bundle">Serve the MCP bundle</h2>
|
||||
<hr />
|
||||
<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>
|
||||
<hr />
|
||||
<h2 id="related">Related</h2>
|
||||
<ul>
|
||||
<li><a href="../03_conventions/">03 – Conventions</a> · <a href="../05_development/01_environment/">01 – Environment</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user