diataxis-docs

What problem does it solve?

It prevents inconsistent, hard-to-navigate documentation by enforcing a strict Diátaxis taxonomy and file layout across tutorials, how-to guides, reference docs, and explanations.

Core Features & Use Cases

• Standardized docs structure: Creates and audits a docs/ layout with the four Diátaxis categories and required category README.md stubs.
• Type-to-category mapping contract: Ensures every documentation type maps to exactly one of the four orthogonal categories, avoiding “FAQ as a category” and “examples as a fifth bucket” anti-patterns.
• Soft drift detection & surface verification: Helps operators identify repos or sites missing the mandated layout and validates that public pages conform during archival verification.

Quick Start

Ask the AI to run the Diátaxis docs mandate for your project and report any missing or miscategorized documentation files.