write-mkdocs-documentation

What problem does it solve?

Guides teams to create, organize, and maintain AirStack MkDocs documentation by providing a structured approach, frontmatter-driven entry points, and standardized formatting that reduces confusion and ensures quality.

Core Features & Use Cases

• Progressive Disclosure: structure docs so newcomers see what matters first and link to deeper material, with clear Learn more patterns.
• Concise Yet Complete: keep pages focused, avoid duplication, and make each section independently scannable.
• Visual Learning: encourage diagrams with Mermaid, reference tables, code examples, and contextual admonitions to improve comprehension.
• MkDocs-Specific Rules: enforce blank lines before lists, navigation conventions, and consistent usage of module vs system docs.
• Documentation Structure Guidance: distinguish module-level READMEs from system docs and outline recommended organization (module docs under module paths; system docs under docs/).

Quick Start

Write or update MkDocs pages following the provided module-system guidelines, verify formatting, and validate navigation and rendering.