README.md•955 B
---
summary: 'Peekaboo documentation map'
read_when:
- 'finding the right Peekaboo doc quickly'
- 'onboarding or sharing docs with teammates'
---
# Documentation map
- **Commands** — `commands/README.md` plus one page per CLI command.
- **Providers** — `providers/README.md` (OpenAI, Anthropic, Grok, Ollama, etc.).
- **Architecture & specs** — `ARCHITECTURE.md`, `spec.md`, `module-architecture-refactoring.md`, `service-api-reference.md`.
- **Testing & QA** — `testing/` plans and manual guides, `reports/` results.
- **References** — `references/` for external API reference excerpts (e.g., Swift toolchain/testing).
- **Research & design notes** — `research/` deep dives and spike notes.
- **Refactor history** — `refactor.md` (current log) and `archive/refactor/` (dated logs).
- **Release & ops** — `RELEASING.md`, `building.md`, `permissions.md`, `security.md`.
Use `pnpm run docs:list` for a searchable summary of all docs.