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
| Path | Purpose |
|---|---|
apps/docs | This documentation site |
apps/tracks-web | Keepin' Tracks web client (Vite + React); see Keepin' Tracks architecture. |
apps/tracks-api | Keepin' Tracks API (Hono on Cloudflare Workers). |
packages/tracks-contracts | Shared 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
- Docs in Git — Markdown/MDX, reviewed like code.
- ADRs for decisions — Use numbered records under
docs/adrs/; see the template and0000guide. - 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.