Documentation

Versioned with the code.
Honest like the code.

Kirra's documentation is not a wiki that drifts — it lives in the repository, gets reviewed like code, and carries explicit status labels. Start anywhere below; every link lands on the source of truth.

Start here

The core reading path

README

The system thesis: doers propose, Kirra bounds — with the component map and safety-goal table.

README.md

Engineering context

The deep operational reference: every module, invariant, constant, and route — kept current because the tooling depends on it.

CLAUDE.md

Install guide

From cargo test to a running governed fleet, on Linux, Docker, Kubernetes, or a Jetson.

INSTALL.md

36 decision records

Every consequential choice — transports, postures, deployment platform, planner seams — argued and numbered.

docs/adr

Safety artifacts (65)

HARA, SOTIF, TARA, UL 4600 GSN, safe-state spec, WCET methodology — each labeled with its real maturity.

docs/safety

Hardware runbooks

ROSMASTER R2 bring-up, e-stop spec, closed-loop tuning, golden builds — the record of putting this on metal.

docs/hardware

Deep dives

Specifications & guides

Incident replay

How bit-identical verdict reconstruction works, and what it refuses to guess about.

docs/REPLAY_INCIDENT_RECONSTRUCTION.md

Vehicle class profiles

The normative envelope numbers for courier, delivery-AV, and robotaxi classes.

docs/CONTRACT_PROFILES.md

Partition boundary spec

The frozen contract layout and the 7-step seqlock trust chain across the hypervisor.

docs/safety/HYPERVISOR_CONTRACT_CHANNEL.md

OTA & Uptane

Dual-slot installs, rollout campaigns, Uptane roles, and the Orin A/B drills.

docs/ota

LLM integration

How to put a language model in the loop without ever putting it in charge.

docs/llm_integration_guide.md

Operator console

Running the fleet console, clearance flows, and the air-gapped fallback console.

docs/CONSOLE_RUNBOOK.md

API reference: cargo doc --open builds the full rustdoc locally — CI enforces deny-warnings on it, so it's always current. docs-and-sdk lane

READ THE SOURCE

If it isn't written down, it didn't happen.

Decision records, drafts, and gap reports included — documentation that admits what it doesn't know yet.

View the repository Browse the documentation