From 48631b57c5c8c5d1d3b5c65a7f972a22b26ab814 Mon Sep 17 00:00:00 2001 From: Vishesh 'ironeagle' Bangotra Date: Mon, 14 Sep 2026 23:30:51 +0530 Subject: [PATCH] docs(wiki): align wiki structure with Aetoskia AGENTS.md guidelines MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 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). --- doc-forge/wiki/01_overview/index.html | 55 +- .../index.html | 69 +- doc-forge/wiki/03_conventions/index.html | 54 +- .../wiki/04_iterative_workflow/index.html | 48 +- .../05_development/01_environment/index.html | 38 +- .../02_quality_gates/index.html | 44 +- .../05_development/03_gsdfc_guide/index.html | 74 +- .../05_development/04_mcp_guide/index.html | 49 +- .../05_mkdocs_configs/index.html | 49 +- doc-forge/wiki/404.html | 14 +- doc-forge/wiki/index.html | 1101 +++++++++-------- doc-forge/wiki/search/search_index.json | 2 +- 12 files changed, 896 insertions(+), 701 deletions(-) rename doc-forge/wiki/{02_architecture => 02_components}/index.html (94%) diff --git a/doc-forge/wiki/01_overview/index.html b/doc-forge/wiki/01_overview/index.html index ba5d199..c04ea1e 100644 --- a/doc-forge/wiki/01_overview/index.html +++ b/doc-forge/wiki/01_overview/index.html @@ -12,7 +12,7 @@ - + @@ -72,7 +72,7 @@
- + Skip to content @@ -226,13 +226,13 @@
  • - + - Architecture + Components
    • @@ -413,27 +413,36 @@
    -

    Keeping stubs in sync

    +
    +

    πŸ”„ Keeping stubs in sync

    Every .py module ships a matching .pyi stub. When a signature or a public symbol changes, update both files. Signature annotations in the stub must match the implementation.

    -

    Enforcement

    +
    +

    πŸ›‘οΈ Enforcement

    pydoclint (Google style) runs in CI and verifies that Args:/Returns: sections match function signatures, including types.

    +
    + + diff --git a/doc-forge/wiki/05_development/04_mcp_guide/index.html b/doc-forge/wiki/05_development/04_mcp_guide/index.html index 5b8b899..a840bad 100644 --- a/doc-forge/wiki/05_development/04_mcp_guide/index.html +++ b/doc-forge/wiki/05_development/04_mcp_guide/index.html @@ -20,7 +20,7 @@ - Mcp Guide - doc-forge + MCP Guide - doc-forge @@ -106,7 +106,7 @@
    - Mcp Guide + MCP Guide
    @@ -224,13 +224,13 @@
  • - + - Architecture + Components
    • @@ -385,12 +385,12 @@
  • - + - Architecture + Components @@ -562,7 +562,7 @@ - Gsdfc Guide + GSDFC Guide @@ -594,7 +594,7 @@ - Mcp Guide + MCP Guide @@ -607,7 +607,7 @@ - Mcp Guide + MCP Guide @@ -632,7 +632,7 @@
  • - Building the bundle + πŸš€ Building the bundle @@ -641,7 +641,7 @@
  • - Serving the bundle + πŸš€ Serving the bundle @@ -650,7 +650,16 @@
  • - Bundle contents + πŸ“¦ Bundle contents + + + +
    • + +
  • + + + Related @@ -677,7 +686,7 @@ - Mkdocs Configs + MkDocs Configs @@ -716,7 +725,8 @@ GSDFC docstrings and serve that bundle over the Model Context Protocol (MCP). The bundle is self-contained: readers can derive the full API reference β€” signatures, docstrings, and structure β€” for the documented project.

    -

    Building the bundle

    +
    +

    πŸš€ Building the bundle

    1
    doc-forge build --mcp --module docforge

    This writes structured JSON into docs/mcp/:

    @@ -725,7 +735,8 @@ signatures, docstrings, and structure β€” for the documented project.

  • nav.json β€” module list with docs://modules/{module} resource URIs
  • modules/{dotted.path}.json β€” per-module serialized documentation
    • -

    Serving the bundle

    +
    +

    πŸš€ Serving the bundle

    1
    doc-forge serve --mcp --module docforge

    The MCPServer (in docforge/servers/mcp_server.py) exposes:

    @@ -755,7 +766,8 @@ signatures, docstrings, and structure β€” for the documented project.

    Missing resources are returned as structured error dictionaries rather than exceptions. The default transport is streamable-http; stdio and sse are supported via MCPServer.run.

    -

    Bundle contents

    +
    +

    πŸ“¦ Bundle contents

    Each module resource contains: