Skip to main content

Architecture overview

Documentation platform

  • Stack: Docusaurus 3 (React, MDX, static build).
  • Package manager: Bun for installs and scripts.
  • Hosting: Static assets on a CDN (e.g. Cloudflare Pages). Production docs URL: https://devdocs.keepintracks.com; see Deployment & access and ADR 0009.

Repository layout

PathPurpose
apps/docsThis documentation site
apps/tracks-webKeepin' Tracks web client (Vite + React); see Keepin' Tracks architecture.
apps/tracks-apiKeepin' Tracks API (Hono on Cloudflare Workers).
packages/tracks-contractsShared types and product constants for Tracks apps.

Additional apps/* or packages/* packages may be added over time; split repositories only when boundaries require it.

Design principles

  1. Docs in Git — Markdown/MDX, reviewed like code.
  2. ADRs for decisions — Use numbered records under docs/adrs/; see the template and 0000 guide.
  3. Access at the edge — Organization-only visibility via Cloudflare Access (or equivalent), not custom auth inside the static site.

See Engineering best practices for team standards (AI-assisted workflow, security, CI expectations) and links to binding ADRs.