/ doc / index.org
index.org
 1  #+title: Mission Control Dashboard — Documentation Index
 2  #+author: Claude Code
 3  #+date: [2026-04-01 Wed]
 4  #+startup: indent
 5  #+options: toc:t num:t ^:{}
 6  
 7  * Overview
 8  
 9  Documentation for the mission control dashboard project — a TanStack Start +
10  XState application that displays live assets on a map using three real-time data
11  transport patterns: polling, WebSocket, and Server-Sent Events. XState machines
12  manage connection lifecycle; =@xstate/store= manages shared application state.
13  
14  * Tutorials
15  
16  - [[file:tutorials/tutorial_mission_control_dashboard.org][Build a Mission Control Dashboard]] — End-to-end build in three phases:
17    OpenSky polling, WebSocket server, MBTA SSE
18  - [[file:tutorials/tutorial_radicle_patch_workflow.org][Radicle Patch Workflow]] — From issue to merge: create, branch, patch, review,
19    merge, close
20  
21  * Explanation
22  
23  - [[file:explanation/explanation_realtime_data_patterns.org][Real-Time Data Patterns]] — Polling vs WebSocket vs SSE: trade-offs, when
24    to use each, decision framework
25  - [[file:explanation/explanation_step3_map_component.org][Anatomy of the Map Component]] — Step 3 unpacked: render hierarchy,
26    declarative-over-imperative, the SSR boundary, CSS as a side effect
27  
28  * How-to Guides
29  
30  - [[file:howto/howto_connect_opensky.org][Connect to OpenSky Network]] — Authentication, bounding boxes, rate limits
31  - [[file:howto/howto_websocket_server.org][Build a WebSocket Server]] — Deploy simulated mission data on your VPS
32  - [[file:howto/howto_consume_sse_react.org][Consume SSE in React with XState]] — EventSource actor, typed events, reconnection
33  
34  * Decisions
35  
36  - [[file:decisions/adr_001_state_store_selection.org][ADR-001: @xstate/store for Application State]] — Why @xstate/store over
37    Zustand, Context, or Jotai
38  - [[file:decisions/adr_002_map_tile_provider.org][ADR-002: Map Tile Provider]] — OSM default tiles for learning, self-hosted
39    upgrade path
40  
41  * Reference
42  
43  - [[file:reference/ref_api_contracts.org][API Contracts]] — Exact data shapes for OpenSky, WebSocket server, and MBTA