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>
|
||||
|
||||
@@ -563,7 +563,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#create-the-environment" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Create the environment
|
||||
🚀 Create the environment
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -572,7 +572,16 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#dependencies" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Dependencies
|
||||
📦 Dependencies
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#related" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Related
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -622,7 +631,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Gsdfc Guide
|
||||
GSDFC Guide
|
||||
|
||||
</span>
|
||||
|
||||
@@ -645,7 +654,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Mcp Guide
|
||||
MCP Guide
|
||||
|
||||
</span>
|
||||
|
||||
@@ -668,7 +677,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Mkdocs Configs
|
||||
MkDocs Configs
|
||||
|
||||
</span>
|
||||
|
||||
@@ -703,7 +712,8 @@
|
||||
|
||||
|
||||
<h1 id="environment-setup">Environment Setup</h1>
|
||||
<h2 id="create-the-environment">Create the environment</h2>
|
||||
<hr />
|
||||
<h2 id="create-the-environment">🚀 Create the environment</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></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>python<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>.venv
|
||||
@@ -711,7 +721,8 @@
|
||||
</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.10+ (per <code>pyproject.toml</code>).</p>
|
||||
<h2 id="dependencies">Dependencies</h2>
|
||||
<hr />
|
||||
<h2 id="dependencies">📦 Dependencies</h2>
|
||||
<p>Development extras include:</p>
|
||||
<ul>
|
||||
<li><code>pytest</code>, <code>pytest-cov</code> — test suite and coverage</li>
|
||||
@@ -720,6 +731,11 @@
|
||||
<li><code>mypy</code> — strict typing checks</li>
|
||||
<li><code>pydoclint</code> — docstring ↔ signature consistency checks</li>
|
||||
</ul>
|
||||
<hr />
|
||||
<h2 id="related">Related</h2>
|
||||
<ul>
|
||||
<li><a href="../../04_iterative_workflow/">04 – Iterative Workflow</a> · <a href="../02_quality_gates/">02 – Quality Gates</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user