documentation-generation

npx skills add cosmicstack-labs/mercury-agent-skills --skill documentation-generation --agent claude-code

Same command for any agent — swap --agent for codex, cursor, copilot.

# Documentation Generation Write documentation that people actually read, understand, and trust — with automated workflows that keep it accurate. ## Core Principles ### 1. Documentation Is Code — Treat It That Way Store docs in the repository, version them with code, review them in PRs, lint them in CI. Documentation that lives in a separate wiki inevitably drifts from reality. ### 2. Write for the Reader's Context Different readers need different documents. A junior developer onboarding needs a step-by-step tutorial. A senior engineer debugging needs API reference. A product manager needs architecture overviews. ### 3. Show, Don't Just Tell Code examples are worth a thousand words of prose. Every API, every workflow, every pattern should be accompanied by a complete, runnable example. ### 4. Document Why, Not Just What The code already tells you what it does. Documentation should explain the reasoning, the tradeoffs, and the edge cases that aren't obvious from reading the implementation. --- ## Documentation Maturity Model | Level | Coverage | Accuracy | Tooling | Maintenance | |-------|----------|----------|---------|-------------| | **1: Skeleton** | README only | Often outdated

Generate a Python client
openapi-generator generate -i openapi.yaml -g python -o client-python
Generate TypeScript types
openapi-generator generate -i openapi.yaml -g typescript-axios -o client-ts
Generate interactive docs (redoc)
npx redoc-cli bundle openapi.yaml -o docs/api.html
Swagger UI (docker)
docker run -p 80:8080 -e SWAGGER_JSON=/openapi.yaml -v $(pwd):/tmp swaggerapi/swagger-ui
TypeScript Documentation Generator
npx typedoc --out docs/api src/