1.2 KiB
Kaptan Developer Manual
Kaptan is an embedded Rust flight-controller project. This manual is the single source of project documentation: board support, safety boundaries, simulation, development workflow, and design references live here as Markdown.
The checked-in firmware is telemetry-only. It does not expose physical motor authority, and no document in this site should be read as a physical-flight release claim.
Start here
- New contributors should read Getting started.
- Board work belongs under Boards.
- The currently supported closed-loop simulation is Host SITL.
- Before submitting changes, follow Development and verification.
Documentation conventions
Documentation is centralized in docs/src/; source directories do not carry
README files. Keep pages in Markdown, add each page to SUMMARY.md, and place
commands beside the assumptions and safety boundary they depend on.
TODO(configuration) marks a required configuration contract that has not
been implemented. It is not permission for an operator to substitute runtime
values or bypass an immutable build-time safety decision.