This directory contains the durable technical documentation for Let's Cube.
- Architecture — system topology, process boundaries, and request/data flow
- Development — local setup, commands, tests, and common development workflows
- Realtime behavior — Socket.IO namespaces, room lifecycle, reconnects, and result delivery
- Data and migrations — MongoDB, PostgreSQL, Prisma, metrics, and persistence guarantees
- Room-to-RaceSession backfill and reconciliation — resumable migration, parity, privacy, and rollback contract
- Production operations — deployment, health checks, rollback, backups, restore, and capacity management
- Release workflow — feature-to-
devintegration,dev-to-masterpromotion evidence, and deployment handoff
- Friendship and blocking lifecycle
- In-app social notifications
- Room and RaceSession contract — durable room/session ownership, lifecycle, privacy, and migration rules
Package documentation:
letscube-scrambles— public exports, provider policy, and adding events
Repository-level documents:
Keep setup and contributor workflow in the development and contributing guides. Put runtime and feature contracts in the closest technical guide or package README. Put production procedures in the operations guide. Tests and code remain the final authority when documentation and implementation disagree.
Do not use documentation files for active task status, issue triage, or backlog planning; keep those in GitHub issues, milestones, and pull requests.