Documentation
OpenRoadCode Documentation
Source:
docs/README.md
This is the central entry point for OpenRoadCode documentation. Implementation-specific README files stay beside the code they describe. The complete catalog below is generated from those canonical files and the standalone guides, so it works directly in GitHub, local Markdown previews, and the documentation website.
The project README remains the repository landing page. Doxygen builds the API reference.
Architecture and design
- System architecture
- Applications architecture audit
- ORC UI architecture
- Automotive architecture
- ORC media integration
- Ethernet interface design
- Android sensor pipeline
- Navigation runtime
- Navigation deployment
- XDG path policy
- Message bus interface design
- Automotive Trip-state interface
- Automotive vehicle-state interface
- Environmental barometric-state interface
- Navigation command-service interface
- Navigation IMU-state interface
- Navigation magnetic-field interface
- Navigation position-state interface
- Route-guidance interface
Features and reference
Complete documentation catalog
Generated from the canonical documentation files. Every component README and standalone guide is listed here. Run python scripts/docs_inventory.py --write after adding or moving documentation.
Apps
- Automotive Dashboard (
apps/automotive_dashboard) - Cartui (
apps/carTui) - Input (
apps/carUi/input) - Carui (
apps/carUi) - Runtime (
apps/carUi/runtime) - Automotive (
apps/demos/automotive) - Launchers (
apps/launchers) - Map Renderer (
apps/map_renderer) - Architecture (
apps/orcUi) - Weatherdash (
apps/weatherDash) - Webui (
apps/webUi)
Common
Config
Controllers
- Audio (
controllers/audio) - Obd2 (
controllers/automotive/obd2) - Automotive (
controllers/automotive) - Cache (
controllers/cache) - Environmental (
controllers/environmental) - Image (
controllers/image) - Input (
controllers/input) - Lighting (
controllers/lighting) - Navigation (
controllers/navigation) - Radio (
controllers/radio) - Route Planning (
controllers/route_planning) - Sdr (
controllers/sdr) - Spotify (
controllers/spotify) - Streaming Radio (
controllers/streaming_radio) - System (
controllers/system) - Video (
controllers/video) - Weather (
controllers/weather)
Development
- Maplibre (
development/containers/maplibre) - Scripts (
development/containers/maplibre/scripts) - Sdrpp (
development/sdrpp) - Remote Control (
development/sdrpp/remote_control) - Telemetry (
development/sdrpp/telemetry) - Termux (
development/termux)
Docs
- Android Sensor Pipeline
- Apps Architecture Audit
- Architecture
- Automotive Architecture
- Ethernet Idd
- Automotive Trip State (
docs/idd) - Automotive Vehicle State (
docs/idd) - Environmental Barometric State (
docs/idd) - Navigation Command Service (
docs/idd) - Navigation Imu State (
docs/idd) - Navigation Magnetic Field State (
docs/idd) - Navigation Position State (
docs/idd) - Route Guidance State (
docs/idd) - Message Bus Idd (
docs/messaging) - Music Visualizer
- Navigation Deployment
- Navigation Runtime
- Online Offline Mode
- Poi Ordering
- Roadmap
- Streaming Radio
- System Performance
- Termux Poi Download
- Xdg Paths
Frontends
- Frontends
- Automotive (
frontends/tk/automotive) - Media (
frontends/tk/media) - Tk (
frontends/tk) - Tui (
frontends/tui)
Hardware Io
- Android (
hardware_io/android) - Elm327 (
hardware_io/automotive/elm327) - Automotive (
hardware_io/automotive) - Bluetooth (
hardware_io/bluetooth) - Environmental (
hardware_io/environmental) - Gpio (
hardware_io/gpio) - Gps (
hardware_io/gps) - Imu (
hardware_io/imu) - Keyboard (
hardware_io/keyboard) - Potentiometer (
hardware_io/potentiometer) - Rotary Encoder (
hardware_io/rotary_encoder)
Input Events
Messaging
Project
Protocols
- Can (
protocols/can) - Map Renderer (
protocols/map_renderer) - Oauth (
protocols/oauth) - Obd2 (
protocols/obd2) - Rigctl (
protocols/rigctl) - Sdrpp Telemetry (
protocols/sdrpp_telemetry) - Spotify (
protocols/spotify)
Scripts
Services
Tools
Ui
Documentation conventions
Keep implementation-specific instructions in the owning component’s README. Put cross-cutting architecture, interface, deployment, and user guides under docs/. Link to canonical files instead of duplicating them. After adding, moving, or removing documentation, run python scripts/docs_inventory.py --write and commit the updated index. CI checks that the catalog is current. The website uses the same discovery inventory, while retaining ownership of its layout, navigation, and deployment.