Start at the top; go deeper as needed.
| Document | Read it when you want to... |
|---|---|
| GETTING_STARTED.md | reach a verified PASS on a laptop, or use a configured hardware/prebuilt-image path |
| USER_GUIDE.md | work with the SDK day-to-day: app generator, prebuilt firmware loop, C modules, repo hygiene |
| API.md | look up the public surface: Rust crates, C ABI, Python package, host contract |
| ARCHITECTURE.md | understand the layers, design rules, mountable backends, and the Universal Driver Interface |
| PORTING.md | adapt existing bounded logic or port NobroRTOS to new silicon |
| HAL_SAL_CONTRACT.md | declare granular native capabilities, profiles, witnesses, and provider lifecycles |
| LIMITATIONS.md | see exact scheduling, resource, isolation, tooling, and platform support boundaries |
| ERROR_CODES.md | decode a stable NOBRO-E0xx failure and take the first recovery step |
| api-index.md | scan the generated per-crate symbol index (appendix to API.md) |
Learning by doing instead? The step-by-step ladder lives in
tutorials/, from a zero-code first light to Rust
deep dives.
Project planning and machine-specific notes are intentionally outside this public documentation set.