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:
@@ -18,7 +18,7 @@
|
||||
|
||||
|
||||
|
||||
<title>Mkdocs Configs - doc-forge</title>
|
||||
<title>MkDocs Configs - doc-forge</title>
|
||||
|
||||
|
||||
|
||||
@@ -104,7 +104,7 @@
|
||||
<div class="md-header__topic" data-md-component="header-topic">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Mkdocs Configs
|
||||
MkDocs Configs
|
||||
|
||||
</span>
|
||||
</div>
|
||||
@@ -222,13 +222,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>
|
||||
@@ -383,12 +383,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>
|
||||
|
||||
@@ -560,7 +560,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Gsdfc Guide
|
||||
GSDFC Guide
|
||||
|
||||
</span>
|
||||
|
||||
@@ -583,7 +583,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Mcp Guide
|
||||
MCP Guide
|
||||
|
||||
</span>
|
||||
|
||||
@@ -615,7 +615,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Mkdocs Configs
|
||||
MkDocs Configs
|
||||
|
||||
</span>
|
||||
|
||||
@@ -628,7 +628,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Mkdocs Configs
|
||||
MkDocs Configs
|
||||
|
||||
</span>
|
||||
|
||||
@@ -653,7 +653,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#file-wins" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
File wins
|
||||
📄 File wins
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -662,7 +662,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#templates" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Templates
|
||||
🧩 Templates
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -671,7 +671,16 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#supported-layouts" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Supported layouts
|
||||
🏗️ Supported layouts
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#related" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Related
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -714,7 +723,8 @@
|
||||
repo that documents kind <code>{kind}</code> carries a config at <code>docs/mkdocs.{kind}.yml</code>
|
||||
that sets <code>docs_dir</code> to the kind's source directory and <code>site_dir</code> to
|
||||
<code>../site/{kind}</code>.</p>
|
||||
<h2 id="file-wins">File wins</h2>
|
||||
<hr />
|
||||
<h2 id="file-wins">📄 File wins</h2>
|
||||
<p><code>docs/mkdocs.{kind}.yml</code> is a repo-owned file, not a build byproduct:</p>
|
||||
<ul>
|
||||
<li><strong>Absent</strong> — <code>doc-forge build --{kind}</code> materializes a copy from the
|
||||
@@ -726,7 +736,8 @@ that sets <code>docs_dir</code> to the kind's source directory and <code>site_di
|
||||
</ul>
|
||||
<p>Because a present file is never rewritten, rerunning a build is a no-op for
|
||||
versioned configs: the working tree stays clean.</p>
|
||||
<h2 id="templates">Templates</h2>
|
||||
<hr />
|
||||
<h2 id="templates">🧩 Templates</h2>
|
||||
<p>The built-in defaults live in <code>docforge/templates/</code>:</p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -759,7 +770,8 @@ kind fragment, then filling in generation-time values (<code>site_name</code>,
|
||||
<code>docs_dir</code>, <code>site_dir</code>, <code>nav</code>, API <code>site_description</code>/<code>site_author</code>, and the
|
||||
theme <code>icon</code> from <code>docforge.nav.yml</code>). Pass <code>--template <path></code> to replace the
|
||||
built-in templates entirely.</p>
|
||||
<h2 id="supported-layouts">Supported layouts</h2>
|
||||
<hr />
|
||||
<h2 id="supported-layouts">🏗️ Supported layouts</h2>
|
||||
<ul>
|
||||
<li><strong>Per-kind config</strong> — the standard layout; each kind builds to
|
||||
<code>site/{kind}</code> and is served under <code>/<repo>/{kind}/</code>.</li>
|
||||
@@ -769,6 +781,11 @@ built-in templates entirely.</p>
|
||||
kind to the root <code>site/</code> dir in this case.</li>
|
||||
</ul>
|
||||
<p>Commit <code>docs/mkdocs.{kind}.yml</code> so served docs are reproducible from source.</p>
|
||||
<hr />
|
||||
<h2 id="related">Related</h2>
|
||||
<ul>
|
||||
<li><a href="../04_mcp_guide/">04 – MCP Guide</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user