These docs describe the standalone aidd runtime and its bundled local web control panel. New to aidd? Start with the Quickstart. For terminology, the canonical glossary is the repository-root CONTEXT.md.
Docs are organized by audience:
- Guides: task-oriented, for operators using aidd.
- Reference: schemas and contracts to look up.
- Architecture: how the runtime works, for contributors.
| Document | Purpose |
|---|---|
| quickstart.md | Install, launch the web panel, add a project, run a first workflow. |
| configuration.md | User and project config files, merge order, accepted keys, examples. |
| what-aidd-modifies.md | Trust reference: everything aidd reads, writes, runs, and sends over the network. |
| backends.md | Backend adapter contract and supported CLI/provider surfaces. |
| deployment.md | Standalone build layout, launch, config/log/data, remote binding, rollback. |
| releasing.md | Maintainer release checklist and rollback plan for the tag-driven release flow. |
| docker.md | Docker image, compose deployment, volumes, agent auth, upgrade/rollback. |
| recipes.md | Bundled file-backed recipes generated from recipes/*.json. |
| ingredients.md | Ingredient catalog: INGREDIENT.md format, groups, support files, one-shots. |
| audits.md | Audit mode usage, outputs, finding contracts, and follow-up flow. |
| director.md | Fleet Director: profile, cycles, suggestions, and the chat agent. |
| interview.md | Interview mode: gathering project context via questions and answers. |
| telemetry.md | Local invocation telemetry and the usage dashboard. |
| triumvirate.md | Triumvirate planning, overseer, execution, and artifacts. |
| auto-rebuild.md | Rebuild workflow for project specs, feature backlogs, audits, and validation. |
| Document | Purpose |
|---|---|
| feature-fields.md | Feature JSON fields, IDs, statuses, roadmap mapping, audit metadata. |
| sample-feature-full.json | Comprehensive valid feature JSON example. |
| project-profile.md | .aidd/project-profile.json schema, fields, and inference behavior. |
| audit-applicability.md | Global and per-project audit applicability mapping and /audits matrix UI. |
| artifacts.md | How each .aidd/ artifact is created or refreshed. |
| execution-flow.md | Execution flow from CLI args through iteration artifacts. |
| project-reports.md | Web bug/feature reports and the feature records they generate. |
| dashboard-data-refresh.md | Dashboard elements, their API endpoints, query keys, and refresh behavior. |
| dashboard-metrics.md | Definition of record for the four dashboard fleet-metric numbers. |
| projects-page-data-refresh.md | Projects list page data sources, query keys, and refresh behavior. |
| project-detail-page-data-refresh.md | Project detail page data sources, query keys, and refresh behavior. |
| Document | Purpose |
|---|---|
| overview.md | Runtime module boundaries and web control panel architecture. |
| project-lifecycle.md | End-to-end project lifecycle: creation/intake → phases → orchestration → audit → maturity → pipeline. |
| compatibility.md | Stable public runtime surfaces, breaking changes, and gates. |
| prompt-compiler.md | Prompt compiler inputs, assembly order, and snapshot keys. |
| prompt-selection.md | How modes, filters, roles, and backends shape prompts. |
| parallel-multi-audit.md | Batched audit behavior and result contract. |
| benchmark-harness.md | CLI-only benchmark runner, fixtures, outputs, and commands. |
| websocket-events.md | WebSocket event contract: events, triggers, payloads, and frontend query invalidations. |
| ADR | Decision |
|---|---|
| 0001-single-user-control-panel.md | Single-user local control panel. |
The public release changelog is CHANGELOG.md (Keep a Changelog format).
Before committing docs or metadata changes in aidd:
bun run start -- --project-dir . --check-features
bun run start -- --project-dir . --check-artifacts
bun run smoke:qc