Peekaboo/docs/README.md
2026-05-17 09:28:07 +01:00

1017 B

summary read_when
Peekaboo documentation map
finding the right Peekaboo doc quickly
onboarding or sharing docs with teammates

Documentation map

  • Commandscommands/README.md plus one page per CLI command.
  • Providersproviders.md for the central provider list; providers/README.md for deep links.
  • Architecture & specsARCHITECTURE.md, spec.md, module-architecture-refactoring.md, service-api-reference.md.
  • Testing & QAtesting/ plans and manual guides, reports/ results.
  • Referencesreferences/ for external API reference excerpts (e.g., Swift toolchain/testing).
  • Research & design notesresearch/ deep dives and spike notes.
  • Refactorsrefactor.md points to the active plan; older migration logs live in archive/refactor/.
  • Release & opsplatform-support.md, RELEASING.md, building.md, permissions.md, security.md.

Use pnpm run docs:list for a searchable summary of all docs.