docs: refresh doc-forge library and MCP bundle
- collect regenerated doc-forge combined site (wiki + lib) - drop stale lib/docforge duplicate subtree - mcp bundle now uses docs:// module resources
This commit is contained in:
@@ -421,6 +421,10 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -505,6 +509,52 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../05_development/03_gsdfc_guide/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Gsdfc Guide
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../05_development/04_mcp_guide/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Mcp Guide
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
@@ -1305,13 +1355,25 @@
|
||||
<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
|
||||
signatures.</p>
|
||||
<p>The authoritative GSDFC specification lives in the <code>docforge/__init__.py</code>
|
||||
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>
|
||||
<li>Use parenthesized types in prose entries (<code>name (Type):</code>) that match the
|
||||
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>
|
||||
<li>Always update the matching <code>.pyi</code> stub alongside the <code>.py</code> implementation.</li>
|
||||
</ul>
|
||||
<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>
|
||||
<h2 id="wiki-pages">Wiki pages</h2>
|
||||
<ul>
|
||||
<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_components.md</code>.</li>
|
||||
<li>File names use a numeric prefix: <code>01_overview.md</code>, <code>02_architecture.md</code>.</li>
|
||||
<li>Nested directories become nested navigation groups:
|
||||
<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
|
||||
|
||||
Reference in New Issue
Block a user