Skip to content

Documentation

This repo uses a modified Diátaxis documentation structure:

  • Getting Started (tutorials) — install, run, and see value fast
  • How-to / Developer Guides — accomplish specific tasks (testing, configuration, extending)
  • Reference — precise, factual surfaces (CLI flags, env vars, schemas)
  • Explanation / Architecture — why the system is structured the way it is

Design history and engineering process docs (specs, ADRs, debt, bugs) are kept, but are not the primary onboarding path.

Getting Started

Developer Guides

Architecture

Project & Process Docs

Category Index Next ID
Specs Design specs + roadmap (mostly archived) SPEC-036
ADRs Architecture decision records ADR-004
Bugs Bug reports & adversarial reviews BUG-039
Debt Technical debt tracking DEBT-108
Vendor Docs External API notes
Ralph Wiggum Protocol Autonomous sprint loop
Archive Completed specs, bugs, debt, and process docs

Master Documents

Future / Brainstorming

Numbering Convention (Process Docs)

  • Specs: Sequential, permanent (SPEC-001, SPEC-002, …)
  • Bugs: Sequential (BUG-001, BUG-002, …)
  • Debt: Sequential (DEBT-001, DEBT-002, …)

Numbers are never reused. Each category README is the SSOT for that category.