Diataxis Overview (EN)

This documentation system is organized by Diataxis:

• Tutorials: step-by-step learning for newcomers.
• How-To Guides: task-oriented operational instructions.
• Reference: authoritative contracts, interfaces, and policies.
• Explanation: architecture rationale, tradeoffs, and migration context.

Governance Mechanism

• Mapping source of truth: docs/diataxis-map.json
• Validation script: node scripts/verify-diataxis-map.js
• Site config: mkdocs.yml (repository root)
• Python dependencies: docs/requirements-mkdocs.txt

Typical Commands

npm run docs:diataxis:check
mkdocs serve --config-file mkdocs.yml
mkdocs build --config-file mkdocs.yml
# publish is handled by GitHub Actions workflow: Docs GitHub Pages Publish

Canonical Source Documents

• Product overview: docs/en/README.md
• Interface contracts: docs/en/Interface Document.md
• User manual: docs/en/User_Manual.md
• app_config guide: docs/en/app_config.toml_guide.md
• Release compare report: docs/en/release_v1.6.0_report.md
• Docs release + rollback runbook: docs/en/docs_release_and_rollback.md

Runtime Config Entry Points

• How-to: Configure app_config.toml
• Reference: app_config.toml Schema

Progress Tracking Entry Points

• Strategy and rationale: Knowledge Mastery Evolution Roadmap
• Implementation status and runbook flow: Development Progress Dashboard
• Cross-doc unresolved-goal audit: Open Goal Audit (2026-05-10)
• Working requirements and execution evidence:
• Brainstorms
• Solutions