Docs

Internal documentation for engineers and agents working in the Compass repo.

Start Here

• Repo Architecture
• Feature File Map
• Common Change Recipes

Common Change Paths

• Auth or session behavior: Frontend Runtime Flow, Password Auth Flow, Google Sync And SSE Flow
• Event shape or recurrence behavior: Event Domain Model, Recurrence Handling
• Event caching, reads, or optimistic writes: Event Caching
• Dragging/resizing events on the week grid: Week Drag Interaction
• Local-first or storage behavior: Offline Storage And Migrations
• Backend routes and API behavior: Backend Route Map, Backend Request Flow, Backend Error Handling
• Event writes, sync transactions, or a new calendar integration: Event Propagation Transactions

Runtime Flows

• Frontend Runtime Flow
• Event Caching
• Week Drag Interaction
• Google Sync And SSE Flow
• Password Auth Flow

Architecture And Domain

• Repo Architecture
• Event Domain Model
• Glossary

Development And Operations

• Local Development
• Hosting Modes
• Self-Hosting
• Testing Playbook
• Types And Validation
• CI/CD Workflows
• CLI And Maintenance Commands
• Versioning

Feature Deep Dives

• Password Auth Flow
• Google Sync And SSE Flow
• Recurrence Handling
• Offline Storage And Migrations

Acceptance

User-visible behavior runbooks for manual verification and expected outcomes:

• Auth
• Events
• Google Sync
• Recurring Events
• Shortcuts