Documentation

Guides

• Installationdocs/INSTALLATION.mdSetup, and what each optional dependency costs you if it is missing.
• User guidedocs/USER_GUIDE.mdPlan, fly, process, measure.
• Pilot guidedocs/PILOT_GUIDE.mdWhat preflight checks, what it cannot, and what the software refuses.
• UI guidedocs/UI_GUIDE.mdThe workspace cockpit: workspaces, dockable panels, shared selection.
• Architecturedocs/ARCHITECTURE.mdHow the layers fit, and the refusal-over-fabrication rule that shapes them.
• API guidedocs/API_GUIDE.mdThe desktop Api and the HTTP service.
• Plugin guidedocs/PLUGIN_GUIDE.mdExtending the toolkit without forking it.
• Deploymentdocs/DEPLOYMENT.mdCompose, Helm, storage, and what PostGIS does not yet give you.

Reference on this site

• FactsEvery product fact in one place, each linked to the line in the repository it comes from.
• Mission templatesAll 22 planner templates, with geometry drawn from real planner output.
• Mission file formatsQGroundControl .plan, ArduPilot .waypoints, DJI WPML .kmz and Litchi CSV, field by field.
• Model cardsThe four registered defect models: data, splits, metrics, weaknesses.
• Thermal R-JPEG guideGetting temperatures out of DJI and FLIR thermal JPEGs, and what OpenDroneKit reads today.
• GSD calculatorGround sample distance, footprint and spacing from camera and altitude.

Only on GitHub

Two documents are linked rather than mirrored. The feature status table is generated by the repository’s own tooling from test results and changes with every run; the simulator guide describes test infrastructure. Read both where they are maintained:

• docs/FEATURES.md: every specified capability with its computed status and the tests behind it.
• docs/SITL.md: running the flight tests against ArduPilot in simulation.