Vishesh 'ironeagle' Bangotra
4b0fdfaf85
- 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).
931 B
931 B
Quality Gates
Run all checks before pushing:
🚀 Commands
.venv\Scripts\python.exe -m pytest
.venv\Scripts\python.exe -m ruff check docforge tests
.venv\Scripts\python.exe -m black --check docforge tests
.venv\Scripts\python.exe -m mypy docforge
.venv\Scripts\pydoclint.exe docforge
📁 Test layout
| Path | Covers |
|---|---|
tests/nav/ |
Nav spec, resolver, wiki nav |
tests/cli/ |
Build command flows and modes |
tests/renderers/ |
MkDocs / MCP rendering |
CLI tests use the cli_runner fixture with mock_mkdocs_build and
mock_mkdocs_load_config so they exercise the full flow without invoking a
real MkDocs build.