# Overview

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.

> **Status:** the checked-in firmware is telemetry-only. It does not expose
> physical motor authority, and this site does not make a physical-flight
> release claim.

## Index

- New contributors should read [Getting started](getting-started.md).
- Firmware source and its Rust workspace begin in `firmware/`; the desktop
  application is a sibling project in `ground-suite/`.
- Board work belongs under [Boards](boards/index.md).
- The currently supported closed-loop simulation is [Host SITL](sitl.md).
- [Configuration](configuration.md) distinguishes the current SITL profile
  from immutable F722 board policy.
- [Logs](logs.md) and [Errors](errors.md) describe the custom MAVLink
  observability surface and its current safety scope.
- Before submitting changes, follow [Development and verification](development.md).

## Documentation conventions

Documentation is centralized in `docs/src/`; individual crates and board
directories do not carry README files. The top-level `firmware/README.md`
only defines the firmware workspace boundary. Keep pages in Markdown, add each
page to `SUMMARY.md`, and place commands beside the assumptions and safety
boundary they depend on.

The current configuration contract is intentionally deployment-specific. A
SITL Quad-X profile is a bounded restart-only CBOR snapshot; F722 hardware
selection remains immutable board policy. Neither is permission for an
operator to substitute runtime values or bypass an immutable safety decision.