# πŸ“š Ponshu Room Lite - Documentation Index **Last Updated**: 2026-01-21 **Purpose**: Central navigation for all project documentation **Audience**: AI collaborators (Claude, Antigravity, Gemini) + Human developers --- ## πŸš€ Quick Start (For New AI Collaborators) **Read these first**: 1. [CURSOR_CHAT_MASTER_CONTEXT.md](architecture/CURSOR_CHAT_MASTER_CONTEXT.md) - Antigravity handoff context 2. [PROJECT_TODO.md](PROJECT_TODO.md) - Current tasks and priorities 3. [DARK_MODE_COLOR_GUIDELINES.md](DARK_MODE_COLOR_GUIDELINES.md) - Critical: Read before any UI changes --- ## πŸ“‹ Task Management | Document | Purpose | When to Use | |----------|---------|-------------| | [PROJECT_TODO.md](PROJECT_TODO.md) | **Active tasks, deferred work** | Before starting any work | | [PROJECT_BACKLOG_MASTER.md](PROJECT_BACKLOG_MASTER.md) | High-level roadmap (52 tasks) | Strategic planning | | [UI_UX_BACKLOG.md](UI_UX_BACKLOG.md) | UI/UX improvements (18 tasks) | Design work | --- ## 🎨 Design & Implementation Guidelines | Document | Purpose | When to Use | |----------|---------|-------------| | [DARK_MODE_COLOR_GUIDELINES.md](DARK_MODE_COLOR_GUIDELINES.md) | **Critical: Dark Mode patterns** | Before ANY UI changes | | [PHASE_2_IMPLEMENTATION_PLAN.md](PHASE_2_IMPLEMENTATION_PLAN.md) | Phase 2 feature specs | Implementing Phase 2 features | | [gamification_specification.md](gamification_specification.md) | Badge/Level/EXP system | Gamification work | --- ## πŸ—οΈ Architecture & Technical | Document | Purpose | When to Use | |----------|---------|-------------| | [ARCHITECTURE_DECISION_RECORD.md](ARCHITECTURE_DECISION_RECORD.md) | Key technical decisions | Understanding "why" | | [CURSOR_CHAT_MASTER_CONTEXT.md](architecture/CURSOR_CHAT_MASTER_CONTEXT.md) | Antigravity handoff | Understanding project history | | [TRANSLATION_STATUS.md](TRANSLATION_STATUS.md) | i18n status | Translation work | --- ## 🎯 Feature-Specific Documentation ### Business Mode - [BUSINESS_MODE_SPECIFICATION.md](BUSINESS_MODE_SPECIFICATION.md) - Business features (menu creation, pricing) ### Future Plans - [future_plan.md](future_plan.md) - Archived long-term ideas - [RECOMMENDATION_EXPANSION_PLAN.md](RECOMMENDATION_EXPANSION_PLAN.md) - "γ‚γ‚γ›γ¦ι£²γΏγŸγ„" expansion (Phase 3) --- ## πŸ” Finding Information ### "Where should I...?" **Q: Fix a Dark Mode visibility issue?** β†’ Read [DARK_MODE_COLOR_GUIDELINES.md](DARK_MODE_COLOR_GUIDELINES.md) first β†’ Check [PROJECT_TODO.md](PROJECT_TODO.md) for deferred Dark Mode fixes **Q: Add a new feature?** β†’ Check [PROJECT_TODO.md](PROJECT_TODO.md) for current priorities β†’ Review [PROJECT_BACKLOG_MASTER.md](PROJECT_BACKLOG_MASTER.md) for planned features β†’ See if it conflicts with [PHASE_2_IMPLEMENTATION_PLAN.md](PHASE_2_IMPLEMENTATION_PLAN.md) **Q: Fix a badge/level/gamification issue?** β†’ [gamification_specification.md](gamification_specification.md) **Q: Understand past decisions?** β†’ [ARCHITECTURE_DECISION_RECORD.md](ARCHITECTURE_DECISION_RECORD.md) β†’ [CURSOR_CHAT_MASTER_CONTEXT.md](architecture/CURSOR_CHAT_MASTER_CONTEXT.md) **Q: Add business mode features?** β†’ [BUSINESS_MODE_SPECIFICATION.md](BUSINESS_MODE_SPECIFICATION.md) **Q: Find a TODO/task?** β†’ [PROJECT_TODO.md](PROJECT_TODO.md) - Active/urgent tasks β†’ [PROJECT_BACKLOG_MASTER.md](PROJECT_BACKLOG_MASTER.md) - All 52 tasks β†’ [UI_UX_BACKLOG.md](UI_UX_BACKLOG.md) - UI/UX-specific --- ## 🚨 Critical Rules (DO NOT SKIP) ### Before Modifying UI Code: 1. βœ… Read [DARK_MODE_COLOR_GUIDELINES.md](DARK_MODE_COLOR_GUIDELINES.md) 2. βœ… Never use `Colors.blue`, `Color(0xFF...)` hardcoded colors 3. βœ… Never use `brightness == Brightness.dark` manual checks 4. βœ… Always use `Theme.of(context).colorScheme.xxx` ### Before Adding Features: 1. βœ… Check [PROJECT_TODO.md](PROJECT_TODO.md) for current priorities 2. βœ… Check [PROJECT_BACKLOG_MASTER.md](PROJECT_BACKLOG_MASTER.md) for planned work 3. βœ… Run `flutter analyze` before and after changes ### Before Committing: 1. βœ… Update relevant documentation 2. βœ… Run `flutter analyze` and fix new warnings 3. βœ… Test in both Light and Dark modes --- ## πŸ“¦ Document Status | Status | Meaning | |--------|---------| | βœ… Complete | Up-to-date, use as reference | | πŸ”„ Needs Update | Partially outdated, use with caution | | πŸ“ In Progress | Being actively updated | | πŸ—ƒοΈ Archived | Historical reference only | ### Current Status - βœ… DARK_MODE_COLOR_GUIDELINES.md - βœ… PROJECT_TODO.md - βœ… CURSOR_CHAT_MASTER_CONTEXT.md - βœ… ARCHITECTURE_DECISION_RECORD.md - βœ… gamification_specification.md - πŸ”„ PROJECT_BACKLOG_MASTER.md (needs Dark Mode status update) - πŸ”„ UI_UX_BACKLOG.md (needs Coach Mark status update) - πŸ“ PHASE_2_IMPLEMENTATION_PLAN.md (being created) - πŸ—ƒοΈ future_plan.md (archived) --- ## 🀝 For AI Collaborators ### Communication Protocol - Update [PROJECT_TODO.md](PROJECT_TODO.md) when tasks change - Leave comments in code explaining "why", not "what" - Follow guidelines strictly to avoid breaking existing work ### Handoff Checklist When transferring work to another AI: - [ ] Update [PROJECT_TODO.md](PROJECT_TODO.md) with progress - [ ] Document any deferred decisions - [ ] Note any discovered issues - [ ] Update relevant spec documents --- ## πŸ“ž Contact & Maintenance **Project Owner**: User (Maita) **Primary AI**: Claude Sonnet 4.5 (via Cursor) **Collaborators**: Antigravity, Gemini **To update this index**: Edit this file when adding/removing documentation. **Last Major Update**: 2026-01-21 (Dark Mode Phase 1 completion) --- ## πŸ—ΊοΈ Document Map (Visual) ``` docs/ β”œβ”€β”€ README.md (← YOU ARE HERE) β”œβ”€β”€ PROJECT_TODO.md ⭐ START HERE β”œβ”€β”€ PROJECT_BACKLOG_MASTER.md (52 tasks) β”œβ”€β”€ UI_UX_BACKLOG.md (18 UI tasks) β”‚ β”œβ”€β”€ Guidelines/ β”‚ β”œβ”€β”€ DARK_MODE_COLOR_GUIDELINES.md ⭐ CRITICAL β”‚ └── TRANSLATION_STATUS.md β”‚ β”œβ”€β”€ Implementation Plans/ β”‚ β”œβ”€β”€ PHASE_2_IMPLEMENTATION_PLAN.md (Phase 2 features) β”‚ β”œβ”€β”€ BUSINESS_MODE_SPECIFICATION.md β”‚ β”œβ”€β”€ gamification_specification.md β”‚ └── RECOMMENDATION_EXPANSION_PLAN.md (Phase 3) β”‚ β”œβ”€β”€ Architecture/ β”‚ β”œβ”€β”€ ARCHITECTURE_DECISION_RECORD.md β”‚ β”œβ”€β”€ CURSOR_CHAT_MASTER_CONTEXT.md (Antigravity handoff) β”‚ └── (other arch docs) β”‚ └── Archive/ └── future_plan.md (historical) ```