Documentation Automation

## What this collection sets up

A documentation-automation workflow that keeps docs accurate as the code changes, organized around the [Diataxis](https://diataxis.fr/) documentation framework (tutorials, how-to guides, reference, explanation). Each piece is an existing, source-backed directory entry; together they generate, measure, validate, and publish documentation.

## Workflow stages

### 1. Generate

- **documentation-generator** (hook) — generates and updates docs from code comments.
- **api-endpoint-documentation-generator** (hook) — documents API endpoints (reference docs).

### 2. Measure and validate

- **documentation-coverage-checker** (hook) — measures documentation coverage and flags missing docs.
- **readme-refresh-validator** (hook) — checks the README for Install/Usage sections and documents the package CLI surface.
- **markdown-link-checker** (hook) — flags broken links in docs and READMEs.
- **documentation-auto-generator-on-stop** (hook) — refreshes docs at session end so they do not drift.

### 3. Explain and publish

- **explain** (command) — produces clear explanations of code (explanation docs).
- **docs** (command) — drafts and updates project documentation.
- **mintlify-docs** (command) — formats and publishes docs to a Mintlify site.

## Suggested order

Generate the reference docs from code first, then measure coverage and validate the README and links, then keep them fresh at session end, and finally use the explanation and publishing commands. See `installationOrder` for the exact sequence.

## Notes

Each entry carries its own prerequisites, safety notes, and privacy notes — read them before enabling a hook that writes documentation or a command that publishes to an external docs site.

## Source and references

- Diataxis documentation framework: https://diataxis.fr/
- Write the Docs (documentation practices): https://www.writethedocs.org/