Skip to main content

Repository Name

Copy this template to docs/repositories/<repo-name>.mdx and replace placeholder content.

Before writing, choose the matching checklist:

Purpose​

Describe why this repository exists and what business or platform problem it solves.

Scope​

  • In scope:
  • Out of scope:

What this app/service does in production​

Describe the real production role in concrete terms (who uses it, what decisions/actions it enables, what goes wrong if it is unavailable).

Primary workflows​

  • Workflow A (trigger -> system behavior -> outcome):
  • Workflow B (trigger -> system behavior -> outcome):

Setup and run​

  • Repository: <repo-url>
  • Local setup guide:
  • Environment/config references:

APIs and interfaces​

  • Inputs (API/events/files/queues):
  • Outputs (actions/events/artifacts):
  • Contracts/schemas/routes:
  • Backend-only note: include endpoint-level behavior and request/response shape expectations for core routes/jobs.

Integrations and dependencies​

  • Upstream dependencies:
  • Downstream consumers:
  • Shared libraries/components:

Operations notes​

  • Runtime model (request/worker/scheduler):
  • Failure modes and diagnostics:
  • Change impact map (if X changes, verify Y/Z):

Source of truth​

  • Key source files/paths (routes, modules, config, jobs):
  • Runbooks/spec links: