Files

Vishesh 'ironeagle' Bangotra 4b0fdfaf85 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).

2026-09-14 23:30:45 +05:30

1.7 KiB

Raw Blame History

Conventions

GSDFC docstrings

All documented source uses the Google-Styled Doc-Forge Convention (GSDFC): Args:, Returns:, Raises:, and Attributes: sections with properly typed signatures.

The authoritative GSDFC specification lives in the docforge/__init__.py package docstring, which is exported verbatim into docs/mcp/modules/docforge.json, so the MCP bundle is self-documenting.

Key rules:

Use parenthesized types in prose entries (name (Type):) that match the signature types.
Use # Summary, # Examples, and # Notes sections at module level.
Use Args:, Returns:, Raises:, Yields:, Notes:, and Example: sections at function and method level.
Always update the matching .pyi stub alongside the .py implementation.

`.pyi` stubs

Every module ships a matching .pyi stub kept in sync with the .py implementation. When signatures change, update both files.

Wiki pages

Hand-written markdown lives in docs/wiki/** and is never generated.
File names use a numeric prefix: 01_overview.md, 02_components.md.
Nested directories become nested navigation groups: 05_development/01_environment.md → group Development.
index.md is the site Home at the root, and a section root inside a directory.
Navigation labels are derived by stripping the numeric prefix and applying title case on the remaining words.

Templates

MkDocs config fragments live in docforge/templates. The mkdocs.wiki.yml fragment carries only the search plugin, since wiki pages contain no mkdocstrings directives.

02 – Components · 04 – Iterative Workflow

1.7 KiB Raw Blame History Unescape Escape