README.md
1 # Mission Control Dashboard - Plans Directory 2 3 This directory contains planning and implementation artifacts for the Mission Control Dashboard. 4 5 ## Directory Structure 6 7 ``` 8 plans/ 9 ├── mission_control_dashboard.prd.org # Product Requirements Document 10 ├── roadmap.org # Org-mode implementation roadmap 11 ├── phase_tracking.org # Progress tracker with TODO checkboxes 12 ├── radicle-issues/ # 32 Radicle issue files 13 └── README.md # This file 14 ``` 15 16 ## What's in Each File 17 18 ### `mission_control_dashboard.prd.org` 19 20 **Purpose:** The formal Product Requirements Document 21 22 Contains: 23 - Executive summary and learning objectives 24 - All functional requirements (F1-F4, N1-N3) 25 - Technical stack and prerequisites 26 - Timeline and acceptance criteria 27 - Risks and future enhancements 28 29 **Use it when:** You need the complete specification of what to build. 30 31 ### `roadmap.org` 32 33 **Purpose:** High-level Org-mode roadmap 34 35 Contains: 36 - Tracer-bullet breakdown of 32 issues 37 - 6 categories: Setup, Phase 1-3, Integration, Future 38 - Issue mapping to PRD requirements 39 40 **Use it when:** You want to see the big picture and navigate between phases. 41 42 ### `phase_tracking.org` 43 44 **Purpose:** Progress tracker with checkboxes 45 46 Contains: 47 - All requirements from the roadmap 48 - Markdown checkboxes for each acceptance criterion 49 - Screenshots and code review checkpoints 50 - Learning outcome verification 51 52 **Use it when:** You want to track your progress through the implementation. 53 54 ### `radicle-issues/` 55 56 **Purpose:** Individual Radicle issue files 57 58 Contains: 59 - 32 Markdown files (one per issue) 60 - Formatted for Radicle issue tracking 61 - Tracer bullets, acceptance criteria, implementation steps 62 63 **Use it when:** You want to work on a specific, independently-implementable task. 64 65 ## How to Use This Directory 66 67 ### For New Contributors 68 69 1. Read `mission_control_dashboard.prd.org` to understand the project 70 2. Open `roadmap.org` in Org-mode to see the full implementation plan 71 3. Pick an issue from `radicle-issues/` to start with 72 4. Track progress in `phase_tracking.org` 73 74 ### For Maintainers 75 76 - `mission_control_dashboard.prd.org` - The source of truth for requirements 77 - `roadmap.org` - High-level planning and navigation 78 - `radicle-issues/` - Triage and assign individual tasks 79 - `phase_tracking.org` - Monitor overall progress 80 81 ### For Learners 82 83 The plans follow a **tracer-bullet approach**: 84 - Each issue is small (20-60 minutes) 85 - Each produces visible progress on the map 86 - Issues build incrementally on each other 87 88 Start with Issue 001 and work through sequentially, or pick a phase 89 (Setup, Phase 1, Phase 2, Phase 3) to focus on. 90 91 ## Project Phases 92 93 | Category | Issues | Focus | 94 |---------|-------|------| 95 | Setup | 001-004 | Project scaffolding, dependencies | 96 | Phase 1 | 005-011 | Aircraft polling with OpenSky | 97 | Phase 2 | 012-018 | Mission assets over WebSocket | 98 | Phase 3 | 019-024 | Transit vehicles via SSE | 99 | Integration | 025-027 | Combine sources, unify UI | 100 | Future | 028-032 | Enhancements and polish | 101 102 ## Labels Convention 103 104 Issues use these labels: 105 - `chore` - setup, configuration, cleanup 106 - `feat` - new functionality 107 - `types` - type definitions 108 - `state` - XState machines 109 - `api` - external API integration 110 - `ui` - visual/interface changes 111 - `integration` - combining components 112 - `backend` - server-side code 113 - `test` - testing/debugging 114 - `performance` - optimizations 115 - `visualization` - map/renderer changes 116 - `configuration` - settings/options 117 118 Phase labels: `phase-0`, `phase-1`, `phase-2`, `phase-3` 119 120 ## Timeline Estimate 121 122 - Setup: 15-30 minutes 123 - Phase 1: 25-35 minutes 124 - Phase 2: 30-40 minutes (includes VPS setup) 125 - Phase 3: 20-30 minutes 126 - Integration: 15-20 minutes 127 - **Total**: ~2-2.5 hours 128 129 ## Notes 130 131 - Each issue is designed to be independently grabbable 132 - Tracer bullets help verify progress quickly 133 - Implementation steps follow the tutorial exactly 134 - Notes include important gotchas and context