# // DOCUMENTATION INDEX

> Master index for `@onlinechefgroep/pi-agent-orchestrator` documentation. All files live in `docs/`.

---

## // CORE DOCUMENTATION

| Document | Description |
|---|---|
| [API Reference](./api-reference.md) | Settings schema, CLI commands, tool interface, hook lifecycle |
| [Architecture](./architecture.md) | System topology, data flow, permission model, file map |
| [Custom Agents](./custom-agents.md) | Markdown frontmatter format, custom agent definitions, handoff protocol |
| [Agentic Loop Spec](./agentic-loop-spec.md) | Autonomous agent loop specification — dispatch → execute → validate → handoff → repeat |
| [Troubleshooting](./troubleshooting.md) | Common issues, diagnostic commands, environment checks |

## // OPERATIONS

| Document | Description |
|---|---|
| [Performance](./PERFORMANCE.md) | Benchmarks, spawn latency optimization, compaction efficiency |
| [How-To: Performance](./HOWTO-perf.md) | Step-by-step profiling, benchmark thresholds, CI interpretation |
| [Overdrive Patterns](./overdrive-patterns.md) | Performance optimization patterns and linter rules |

## // REPO INDEX

| File | Purpose |
|---|---|
| `../README.md` | Public overview, badges, installation, feature table |
| `../CONTRIBUTING.md` | Dev setup, testing, lint, PR workflow, code of conduct |
| `../CHANGELOG.md` | Version history with dates and change details |
| `../SECURITY.md` | Vulnerability reporting process, supported versions |
| `../CODE_OF_CONDUCT.md` | Contributor Covenant v2.1 |
| `../ROADMAP.md` | Public roadmap — current state, planned features, out-of-scope |
| `../LICENSE` | MIT License — full text |
| `../AGENTS.md` | Developer guide — common mistakes, conventions, rules |
| `../docs/repository.md` | Repository structure overview |