aetos/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: refresh doc-forge split sites (lib + wiki)

Browse Source
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-09-12 14:23:24 +05:30
parent 167d44fcfe
commit bf83538136
162 changed files with 10183 additions and 22164 deletions
Download Patch File Download Diff File Expand all files Collapse all files

773
doc-forge/wiki/04_iterative_workflow/index.html
View File

@@ -15,7 +15,7 @@
<link rel="next" href="../05_development/01_environment/">
<link rel="icon" href="../../assets/images/favicon.png">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
@@ -24,10 +24,10 @@
<link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
@@ -46,11 +46,9 @@
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -92,7 +90,7 @@
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
<a href=".." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 4v18h16v2H4c-1.1 0-2-.9-2-2V4zm11 3h5.5L15 1.5zM8 0h8l6 6v12c0 1.11-.89 2-2 2H8a2 2 0 0 1-2-2V2c0-1.11.89-2 2-2m9 16v-2H8v2zm3-4v-2H8v2z"/></svg>
@@ -209,7 +207,7 @@
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
<a href=".." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 4v18h16v2H4c-1.1 0-2-.9-2-2V4zm11 3h5.5L15 1.5zM8 0h8l6 6v12c0 1.11-.89 2-2 2H8a2 2 0 0 1-2-2V2c0-1.11.89-2 2-2m9 16v-2H8v2zm3-4v-2H8v2z"/></svg>
@@ -227,7 +225,7 @@
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<a href=".." class="md-nav__link">
@@ -374,18 +372,18 @@
</li>
<li class="md-nav__item">
<a href="#what-a-combined-build-does" class="md-nav__link">
<a href="#what-a-build-does" class="md-nav__link">
<span class="md-ellipsis">
What a combined build does
What a build does
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#explore-the-site" class="md-nav__link">
<a href="#explore-the-sites" class="md-nav__link">
<span class="md-ellipsis">
Explore the site
Explore the sites
</span>
</a>
@@ -562,716 +560,6 @@
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<div class="md-nav__link md-nav__container">
<a href="../../lib/loaders/" class="md-nav__link ">
<span class="md-ellipsis">
Loaders
</span>
</a>
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Loaders
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../lib/loaders/griffe_loader/" class="md-nav__link">
<span class="md-ellipsis">
Griffe Loader
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<div class="md-nav__link md-nav__container">
<a href="../../lib/models/" class="md-nav__link ">
<span class="md-ellipsis">
Models
</span>
</a>
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<span class="md-nav__icon md-icon"></span>
Models
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../lib/models/module/" class="md-nav__link">
<span class="md-ellipsis">
Module
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/models/object/" class="md-nav__link">
<span class="md-ellipsis">
Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/models/project/" class="md-nav__link">
<span class="md-ellipsis">
Project
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
<div class="md-nav__link md-nav__container">
<a href="../../lib/nav/" class="md-nav__link ">
<span class="md-ellipsis">
Navigation
</span>
</a>
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_9">
<span class="md-nav__icon md-icon"></span>
Navigation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../lib/nav/spec/" class="md-nav__link">
<span class="md-ellipsis">
Spec
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/nav/resolver/" class="md-nav__link">
<span class="md-ellipsis">
Resolver
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/nav/mkdocs/" class="md-nav__link">
<span class="md-ellipsis">
Mkdocs
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
<div class="md-nav__link md-nav__container">
<a href="../../lib/renderers/" class="md-nav__link ">
<span class="md-ellipsis">
Renderers
</span>
</a>
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_10">
<span class="md-nav__icon md-icon"></span>
Renderers
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../lib/renderers/base/" class="md-nav__link">
<span class="md-ellipsis">
Base
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/renderers/mkdocs_renderer/" class="md-nav__link">
<span class="md-ellipsis">
Mkdocs Renderer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/renderers/mcp_renderer/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Renderer
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
<div class="md-nav__link md-nav__container">
<a href="../../lib/cli/" class="md-nav__link ">
<span class="md-ellipsis">
CLI
</span>
</a>
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_11">
<span class="md-nav__icon md-icon"></span>
CLI
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../lib/cli/main/" class="md-nav__link">
<span class="md-ellipsis">
Main
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/cli/commands/" class="md-nav__link">
<span class="md-ellipsis">
Commands
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/cli/api_utils/" class="md-nav__link">
<span class="md-ellipsis">
Api Utils
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/cli/mcp_utils/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Utils
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/cli/mkdocs_utils/" class="md-nav__link">
<span class="md-ellipsis">
Mkdocs Utils
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
@@ -1308,18 +596,18 @@
</li>
<li class="md-nav__item">
<a href="#what-a-combined-build-does" class="md-nav__link">
<a href="#what-a-build-does" class="md-nav__link">
<span class="md-ellipsis">
What a combined build does
What a build does
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#explore-the-site" class="md-nav__link">
<a href="#explore-the-sites" class="md-nav__link">
<span class="md-ellipsis">
Explore the site
Explore the sites
</span>
</a>
@@ -1366,7 +654,7 @@
<span class="normal"><a href="#__codelineno-0-11">11</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><span class="c1"># Library reference only</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a>doc-forge<span class="w"> </span>build<span class="w"> </span>--mkdocs<span class="w"> </span>--module<span class="w"> </span>docforge
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a><span class="c1"># Wiki + library combined (single MkDocs build)</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a><span class="c1"># Wiki + library (each an independent MkDocs build)</span>
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5"></a>doc-forge<span class="w"> </span>build<span class="w"> </span>--wiki<span class="w"> </span>--mkdocs<span class="w"> </span>--module<span class="w"> </span>docforge
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6"></a>
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7"></a><span class="c1"># Wiki only — no module required</span>
@@ -1375,20 +663,29 @@
</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-combined-build-does">What a combined build does</h2>
<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>
<li>Generates API sources under <code>docs/api/**</code> when <code>--api</code> is given.</li>
<li>Derives wiki navigation from <code>docs/wiki/**</code>.</li>
<li>Writes <code>mkdocs.yml</code> with merged navigation — wiki first, generated groups
appended, and the wiki <code>Home</code> replacing any spec <code>Home</code> entry.</li>
<li>Runs <code>mkdocs build</code> once and emits the site.</li>
<li>Derives the wiki navigation from <code>docs/wiki/**</code>.</li>
<li>Writes one MkDocs config per site kind (<code>docs/mkdocs.{lib,api,wiki}.yml</code>),
re-rooting navigation paths to each kind's <code>docs_dir</code>.</li>
<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-site">Explore the site</h2>
<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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1"></a>doc-forge<span class="w"> </span>build<span class="w"> </span>--wiki<span class="w"> </span>--mkdocs<span class="w"> </span>--module<span class="w"> </span>docforge
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2"></a>doc-forge<span class="w"> </span>serve<span class="w"> </span>--mkdocs<span class="w"> </span>--mkdocs-yml<span class="w"> </span>mkdocs.yml
<span class="normal"><a href="#__codelineno-1-2">2</a></span>
<span class="normal"><a href="#__codelineno-1-3">3</a></span>
<span class="normal"><a href="#__codelineno-1-4">4</a></span>
<span class="normal"><a href="#__codelineno-1-5">5</a></span>
<span class="normal"><a href="#__codelineno-1-6">6</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1"></a>doc-forge<span class="w"> </span>build<span class="w"> </span>--wiki<span class="w"> </span>--mkdocs<span class="w"> </span>--module<span class="w"> </span>docforge
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2"></a>doc-forge<span class="w"> </span>serve<span class="w"> </span>--wiki<span class="w"> </span><span class="c1"># serves site preview from docs/mkdocs.wiki.yml</span>
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3"></a>doc-forge<span class="w"> </span>serve<span class="w"> </span>--lib
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4"></a>doc-forge<span class="w"> </span>serve<span class="w"> </span>--api
</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>
<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>
@@ -1451,10 +748,10 @@
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
<script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
</body>