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:
@@ -12,7 +12,7 @@
|
||||
<link rel="prev" href="..">
|
||||
|
||||
|
||||
<link rel="next" href="../02_architecture/">
|
||||
<link rel="next" href="../02_components/">
|
||||
|
||||
|
||||
<link rel="icon" href="../assets/images/favicon.png">
|
||||
@@ -72,7 +72,7 @@
|
||||
<div data-md-component="skip">
|
||||
|
||||
|
||||
<a href="#overview" class="md-skip">
|
||||
<a href="#library-overview" class="md-skip">
|
||||
Skip to content
|
||||
</a>
|
||||
|
||||
@@ -226,13 +226,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>
|
||||
@@ -413,27 +413,36 @@
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#what-it-generates" class="md-nav__link">
|
||||
<a href="#which-build-should-you-use" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
What it generates
|
||||
🧭 Which Build Should You Use?
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#per-kind-mkdocs-builds" class="md-nav__link">
|
||||
<a href="#architecture" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Per-kind MkDocs builds
|
||||
🏗️ Architecture
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#mcp-bundle" class="md-nav__link">
|
||||
<a href="#lifecycle-rules" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
MCP bundle
|
||||
🔄 Lifecycle Rules
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#read-next" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
➡️ Read Next
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -454,12 +463,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>
|
||||
|
||||
@@ -628,7 +637,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Gsdfc Guide
|
||||
GSDFC Guide
|
||||
|
||||
</span>
|
||||
|
||||
@@ -651,7 +660,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Mcp Guide
|
||||
MCP Guide
|
||||
|
||||
</span>
|
||||
|
||||
@@ -674,7 +683,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Mkdocs Configs
|
||||
MkDocs Configs
|
||||
|
||||
</span>
|
||||
|
||||
@@ -708,11 +717,12 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="overview">Overview</h1>
|
||||
<h1 id="library-overview">Library Overview</h1>
|
||||
<p><code>docforge</code> turns GSDFC-compliant Python docstrings into maintainable reference
|
||||
documentation. It never edits source docstrings; it reads them, renders them,
|
||||
and assembles documentation sites from all available material.</p>
|
||||
<h2 id="what-it-generates">What it generates</h2>
|
||||
<hr />
|
||||
<h2 id="which-build-should-you-use">🧭 Which Build Should You Use?</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -744,7 +754,8 @@ and assembles documentation sites from all available material.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="per-kind-mkdocs-builds">Per-kind MkDocs builds</h2>
|
||||
<hr />
|
||||
<h2 id="architecture">🏗️ Architecture</h2>
|
||||
<p>Each enabled site kind produces its own MkDocs configuration and build:</p>
|
||||
<ol>
|
||||
<li><code>--mkdocs</code> (lib) writes <code>docs/mkdocs.lib.yml</code> and builds <code>site/lib/</code>.</li>
|
||||
@@ -754,10 +765,16 @@ and assembles documentation sites from all available material.</p>
|
||||
<p>Every site is self-contained (own theme assets and search index) with
|
||||
navigation derived or scoped to that kind. Hand-written wiki content is never
|
||||
overwritten or regenerated — only its navigation is derived automatically.</p>
|
||||
<h2 id="mcp-bundle">MCP bundle</h2>
|
||||
<hr />
|
||||
<h2 id="lifecycle-rules">🔄 Lifecycle Rules</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>
|
||||
<hr />
|
||||
<h2 id="read-next">➡️ Read Next</h2>
|
||||
<ul>
|
||||
<li><a href="../02_components/">02 – Components</a> · <a href="../03_conventions/">03 – Conventions</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user