The docs/ tree is organized by the Diátaxis model:
tutorials (learning), guides (tasks), reference (lookup), and
explanation (understanding) — plus binding design docs and planning
artifacts.
| Area | Type | Purpose |
|---|
tutorials/ | Tutorials | Learning-oriented, step-by-step lessons (themes, plugins). |
guides/ | How-to | Task-oriented guides: onboarding, local dev, scaffolds, hot-reload, publishing, testing, debugging, operations/ runbooks. |
reference/ | Reference | Lookup: CLI, manifest v3, runtime config, package spec, generated plugin cards. |
explanation/ | Explanation | Understanding: architecture/ and features/ deep-dives. |
design-docs/ | Doctrine | Approved, binding design documents. Start at D0. |
user_guide/ | How-to | End-user / operator onboarding and setup. |
marketplaces/ | Reference | Submission and item-retirement policy. |
superpowers/ | Planning | Active plans, completed plans, reports, and archive. |
- Current roadmap:
docs/roadmap.md
- Completed plans:
docs/superpowers/plans/done/
- Active/deferred plans:
docs/superpowers/plans/
- Generated docs (plugin cards, stats blocks) carry a “do not edit by hand”
note — change the source, then run
make docs-gen / make docs-stats.
make docs-lint verifies D-doc invariants and that every intra-repo link
resolves. Run it before committing doc changes.
- If docs and code drift, treat code and current runbooks as source of truth,
then update docs.
- Historical / superseded docs live in
superpowers/archive/ or .tmp/docs-archive-*.