Skip to content

Fleet Dispatch — Documentation Index

Two tracks, kept in sync. Pick the one that matches what you need:

  • docs/technical/ — full implementation detail: wire formats, signing math, gate rules, CI gates, exact file paths. For anyone building on or operating this repo.
  • docs/plain/ — the same ground, in plain English, no code, no wire-format tables. For anyone who wants to understand what this does and why without reading source.
Topic Technical Plain
What it is / how it works technical/ARCHITECTURE.md plain/OVERVIEW.md
Setup / first run technical/getting-started.md plain/getting-started.md
Working on the codebase technical/contributing.md — (technical-only; contributing is a developer activity)
Standards, tools, patterns used technical/references.md plain/learn-more.md
How it was built (LIVING) technical/making-of.md plain/making-of.md
Diagrams diagrams/ (Mermaid + C4/D2) same — diagrams aren't track-specific

Contract documents (frozen or near-frozen; not part of the two-track set)

These predate the two-track structure and stay where they are — they are specific, versioned contracts other repos or subsystems implement against, not general architecture narrative:

Note on the repo-registry: this repo carries the scanner (RepoRegistryScanner, RepoRegistrySigner) that mirrors a contract owned elsewhere — fleet-mission-control/docs/repo-registry-contract.md is the frozen contract document; it is not duplicated in this repo. See technical/ARCHITECTURE.md § Repo registry scanner for what this repo's mirror covers and why byte-for-byte fidelity to that external contract matters.

Superseded

architecture.md and plain.md at the top of docs/ are the original single-file architecture/plain docs, written before the two-track structure above existed. They are marked superseded in place (each carries a banner) rather than deleted, so existing links keep resolving; treat technical/ARCHITECTURE.md and plain/OVERVIEW.md as the maintained versions going forward.

Root-level docs

../README.md is the repo root README — CLI command reference, target resolution, security posture, governor integration, LAN addressing, and the persistent-listener install procedure. It is operational reference (exact commands, exact flags) rather than narrative architecture; the technical track above links into it where relevant instead of duplicating it.