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:
@@ -9,7 +9,7 @@
|
||||
|
||||
|
||||
|
||||
<link rel="prev" href="../02_architecture/">
|
||||
<link rel="prev" href="../02_components/">
|
||||
|
||||
|
||||
<link rel="next" href="../04_iterative_workflow/">
|
||||
@@ -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>
|
||||
|
||||
@@ -490,6 +490,15 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#related" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Related
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -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>
|
||||
|
||||
@@ -718,6 +727,7 @@
|
||||
|
||||
|
||||
<h1 id="conventions">Conventions</h1>
|
||||
<hr />
|
||||
<h2 id="gsdfc-docstrings">GSDFC docstrings</h2>
|
||||
<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
|
||||
@@ -726,32 +736,40 @@ signatures.</p>
|
||||
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>
|
||||
<ol>
|
||||
<li>Use parenthesized types in prose entries (<code>name (Type):</code>) that match the
|
||||
signature types.</li>
|
||||
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>
|
||||
sections at function and method level.</li>
|
||||
<li>Always update the matching <code>.pyi</code> stub alongside the <code>.py</code> implementation.</li>
|
||||
</ul>
|
||||
</ol>
|
||||
<hr />
|
||||
<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>
|
||||
<hr />
|
||||
<h2 id="wiki-pages">Wiki pages</h2>
|
||||
<ul>
|
||||
<ol>
|
||||
<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_architecture.md</code>.</li>
|
||||
<li>File names use a numeric prefix: <code>01_overview.md</code>, <code>02_components.md</code>.</li>
|
||||
<li>Nested directories become nested navigation groups:
|
||||
<code>05_development/01_environment.md</code> → group <em>Development</em>.</li>
|
||||
<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
|
||||
directory.</li>
|
||||
directory.</li>
|
||||
<li>Navigation labels are derived by stripping the numeric prefix and applying
|
||||
title case on the remaining words.</li>
|
||||
</ul>
|
||||
title case on the remaining words.</li>
|
||||
</ol>
|
||||
<hr />
|
||||
<h2 id="templates">Templates</h2>
|
||||
<p>MkDocs config fragments live in <code>docforge/templates</code>. The <code>mkdocs.wiki.yml</code>
|
||||
fragment carries only the <code>search</code> plugin, since wiki pages contain no
|
||||
mkdocstrings directives.</p>
|
||||
<hr />
|
||||
<h2 id="related">Related</h2>
|
||||
<ul>
|
||||
<li><a href="../02_components/">02 – Components</a> · <a href="../04_iterative_workflow/">04 – Iterative Workflow</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user