Docs

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

Start Here

• Repo Architecture
• Product Suite Boundaries
• 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, Common Change Recipes
• Attendees, contact suggestions, or RSVP: Attendees, Contacts, And RSVP, Feature File Map
• Event caching, reads, or optimistic writes: Event Caching
• Dragging/resizing events on the week grid: Week Drag Interaction
• Keyboard shortcuts, event jump, or pointer suppression: Shortcut Commandments, Shortcuts, Contextual Pointer Guidance, Feature File Map
• Welcome, Shortcut Showcase, or the first-event handoff prompt: Feature File Map, Frontend Runtime Flow
• Breakpoints, sidebar collapse, or layout at different viewport sizes: Responsive Layout
• Local-first or storage behavior: Offline Storage And Migrations
• Backend routes and API behavior: Backend Route Map, Backend Request Flow, Backend Error Handling
• Trial, pricing, or Stripe: Billing And Trial
• Public booking pages or availability rules: Compass Calendar Booking (v1)
• A new calendar integration or Google-sync behavior: Google Sync And SSE Flow, the packages/sync domain code directly

Architecture And Domain

• Repo Architecture
• Product Suite Boundaries
• Event Domain Model
• Multi-account Sync
• Glossary

Development And Operations

• Local Development
• Troubleshooting
• Configuration
• Hosting Modes
• Self-Hosting
• Testing Playbook
• Launch Ops Checklist
• Performance Baselines
• Types And Validation
• CI/CD Workflows
• Error Autofix Routine
• Booking loop Routine
• CLI And Maintenance Commands
• Versioning

Acceptance

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

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