Skip to main content

Backend Operations Runbook

Operational commands and procedures for backend development and documentation.

Local Development​

From monorepo root:

yarn workspace @adamondo/backend start

Quality Checks​

yarn workspace @adamondo/backend lint
yarn workspace @adamondo/backend tsc --noEmit

Build​

yarn workspace @adamondo/backend build

Database Migration​

yarn workspace @adamondo/backend prisma:migrate:deploy

Create migration during development:

yarn workspace @adamondo/backend prisma:migrate:dev

Seed​

yarn workspace @adamondo/backend prisma:seed

Documentation Generation​

Generate backend workflow + notification + TypeScript API docs:

yarn workspace @adamondo/backend generate:docs

Generate only TypeScript API reference:

yarn workspace @adamondo/backend generate:docs:api

Docs output locations:

  • Workflow docs: apps/backend/docs/RESERVATION_WORKFLOW.md, apps/backend/docs/DOCUMENT_APPROVAL_WORKFLOW.md
  • Notification docs: apps/backend/docs/NOTIFICATION_README.md
  • API docs: apps/backend/docs/api/**

Docusaurus Portal​

From monorepo root:

yarn docs:start

Build static docs:

yarn docs:build

Common Failures​

TypeDoc fails with missing exports or typing errors​

  • Run yarn workspace @adamondo/backend tsc --noEmit.
  • Fix TS errors first, then rerun docs generation.

Docusaurus route or sidebar mismatch​

  • Ensure generated markdown exists under apps/backend/docs.
  • Ensure file names are .md or .mdx.
  • Run yarn --cwd docs clear then yarn docs:start.

Missing generated docs in portal​

  • Re-run:
    • yarn workspace @adamondo/backend generate:docs
    • yarn docs:build