Overview
- Orbitron is organised as a Rust Cargo workspace where each crate owns a distinct layer: data backbone, query language, GPU renderer, services, UI shells, automation CLIs, and optional bridges (Python, plugin SDK).
- The user-facing binaries (
orbitron,orbitron-tui) are thin entrypoints over the sharedcore/*crates. The GUI viewer (ui/shell) composes the same services with an egui/WGPU frontend. - The workspace enforces
#![deny(unsafe_code)]and#![deny(missing_docs)]on core crates. Public APIs must ship with documentation comments and error handling viaanyhowor typedthiserrorenums. - Prefer fallible parsing with
Result/Optionin production code: avoidunwrap/expectoutside tests, log recoverable parser failures withtracing::warn, and surface actionableIoPipelineError::ParseErrormessages for malformed inputs.
Documentation layout
This Developer Guide is the authoritative architectural reference for contributors. For end-user workflows (installation, GUI usage, CLI commands), refer to the companion USER_GUIDE.md in this same directory.