Files
skyg-linux-tracker/docs
ari 1a30b20ac0 Stamp the version as YYYY.MM.DD-<branch>-<sha>
build.rs builds the string (git, or SLINUXM_* env for builds without .git)
and the lib exposes it as VERSION. --version, /healthz, /api/v1/ping, MCP
server info and OTel service.version use it; OpenAPI info.version stays on
the semver so docs/openapi.json does not change per commit. The flake passes
the commit date and short rev to the package.
2026-10-20 23:27:46 -04:00
..
2026-10-20 16:35:11 -04:00
2026-10-20 16:35:11 -04:00
2026-10-19 14:14:29 -04:00

Documentation index

Root files: README.md (install and usage), ARCHITECTURE.md (design, decisions, verification), TODO.md (work tracking), AGENTS.md (guidance for AI coding agents). Plans for the next big phase go in plan/.

Reference

Doc Contents
api.md Full REST route table, MCP tools/prompts/resources, client setup, Origin and Host checks
openapi.json Generated OpenAPI 3.1 description of the REST API and MCP endpoint; regenerate with cargo run -- openapi --peers > docs/openapi.json
tls.md Native TLS: configuration, self-signed example, SIGHUP rotation, ACME and sops paths
consolidator.md Peers (consolidator): config, agenix tokens, threat model, firewall, reload

Workstream records (archived)

Archived. The files in workstreams/ are historical records of how the project was built (scope, owned files, design notes, logs). They are not maintained. Current design is in ARCHITECTURE.md and open work is in TODO.md.

Card Phase Depends on
P0 Foundation 0 none
WS-A systemd 1 P0
WS-B journal 1 P0
WS-C docker 1 P0
WS-D auth + DB 1 P0
WS-E REST 2 A, B, C, D
WS-F MCP 2 A, B, C, D
WS-G OTel 2 A, B, C
P3 Integration 3 E, F, G
WS-I TLS 4 P3
WS-H NixOS 4 P3, WS-I (gate result pending)
P5 Consolidator 5 WS-H, WS-I (folder: contracts, decisions, WS-T and A to F)
WS-G OpenAPI 5 (stand-alone) P5
WS-H final fixes 5 P5 final review

Dependency order: P0, then A to D in parallel, then E to G in parallel, then P3, then WS-I, then WS-H. Phase 5 (P5) came after, then the OpenAPI doc and the final fixes.