Documentation index
Agent Detective — documentation
Section titled “Agent Detective — documentation”AI-powered code analysis (Jira, webhooks, PR pipeline, local repos, and more). The root README.md has a quick start; this page maps docs/ so you can jump to the right guide.
Operators (start here)
Section titled “Operators (start here)”| Doc | For |
|---|---|
| get started | Five-minute npm install, init, mock smoke |
| CLI reference | init, doctor, smoke, validate-config |
| golden path | Local smoke → real Jira webhook |
| installation | npm vs from-source vs bare metal |
| deployment | systemd, nginx, health checks |
| configuration hub | Load order, env whitelist |
| upgrading | npm and git upgrade runbooks |
Other areas
Section titled “Other areas”| Area | Path | For |
|---|---|---|
| Configuration (full) | config/ | Env tables, plugin narratives |
| Plugins | plugins/ | Authoring, extending, publishing |
| Contribute | development/ | pnpm, Turbo, agent harness, golden rules |
| Design | architecture/ | System view, ADR |
| Manual E2E | e2e/ | Jira/Linear tunnel walkthroughs (after get started) |
| Generated reference | reference/generated/ | Zod schemas for app + plugin options |
| Tool refs | references/ | pnpm, Turbo, ESM (low-token) |
Published site: pnpm run docs:site → apps/docs/README.md. Source syncs to Starlight on build; home page apps/docs/src/content/docs/index.mdx is hand-edited.