Skip to main content

How-To

Recipe-style guides for specific development tasks. Each guide answers a single "how do I…?" question with a concrete, reproducible sequence of steps.

What belongs here​

  • Development workflows (e.g. how to add a new API endpoint, how to write a migration)
  • Local setup tasks (e.g. how to run the backend locally, how to configure a service for local dev)
  • One-off operational tasks that are not incident procedures (e.g. how to manually trigger a recording upload)

What does not belong here​

  • Background explanation of how a system works → ../reference/
  • Incident and recovery procedures → ../runbooks/
  • Why a decision was made → ../adr/

Current guides​

GuideDescription
write-endpoint.mdHow to add a new REST endpoint following the established Gin + feature module pattern
livekit-cli.mdHow to use the LiveKit CLI for local development and debugging

Phase 0 note: additional guides to be added during baseline generation.