Skip to content

fleet-routine — Documentation Index

Two tracks, kept in sync. Pick one:

  • Technical track (docs/technical/) — for engineers. Code-accurate, labels every claim BUILT or DESIGNED.
  • Plain track (docs/plain/) — for everyone else. Same facts, no code, everyday analogies.

Project status right now: early. Only Gate 0 (FLT-104, the doctor auth smoke test) is built. Everything else is designed, not built. See docs/BOARD.md for live ticket status.

Technical track

Doc What's in it
technical/ARCHITECTURE.md The intended scheduling-plane architecture (WTS trigger → thin runner → fleet-harness; registry; governance) — clearly split from what's actually built (the Gate 0 doctor CLI: S4U probe-task lifecycle, six-harness probe contract, nonce canary). Includes the on-disk solution layout.
technical/references.md External references: Windows Task Scheduler S4U, HMAC/nonce patterns, the six harness CLIs, cron.
technical/making-of.md (LIVING) The design/build journey, beat by beat, from git log + BUILD-REPORT.md + the spec.

Plain track

Doc What's in it
plain/OVERVIEW.md What a "routine" is (like Claude Code's scheduled tasks, fleet-wide), and what Gate 0 actually proves — no code.
plain/learn-more.md The same background reading as the technical references, explained in plain language.
plain/making-of.md (LIVING) The same journey as the technical making-of, without commit hashes or file names.

Diagrams

All Mermaid, all renderable inline on GitHub/GitLab/most Markdown viewers. No SVG export tool is installed in this repo yet (there's no CI to gate on it either — this repo predates any CI setup). TODO: once a CI workflow exists, wire mmdc (@mermaid-js/mermaid-cli) in to render and check in SVGs. Never Visio.

Diagram Status What it shows
diagrams/context-c4.md mixed (labelled) C4 system-context: fleet-routine and its neighbors (fleet-harness, WTS, the six harnesses, NATS, usage-governor, Pavlok).
diagrams/doctor-probe-flow.md BUILT The Gate 0 doctor probe-task lifecycle: register → trigger → probe six harnesses → canary match → result.
diagrams/auth-smoke-gate.md BUILT The go/no-go gate decision logic, including the allowlist rule that can never excuse a broken credential.
diagrams/routine-lifecycle.md DESIGNED, not built The full intended routine lifecycle (WTS trigger → runner → fleet-harness → NATS → Pavlok) and the FLT-105→108 ticket sequence.

Source documents these are built from

  • ../README.md — repo root README.
  • ../BOARD.md — canonical live delivery board (also mirrored to Vikunja + Jira).
  • FLT-104-gate0-auth-smoke-spec.md — the Gate 0 spec.
  • ../BUILD-REPORT.md — the Gate 0 build/verification record.
  • src/FleetRoutine.Cli/ and tests/FleetRoutine.Tests/ — the actual code (read alongside technical/ARCHITECTURE.md §2, not instead of it).