Files
skyg-linux-tracker/docs
2026-10-21 00:12:33 -04:00
..
2026-10-20 16:35:11 -04:00
2026-10-21 00:12:33 -04:00
2026-10-21 00:12:33 -04:00
2026-10-21 00:12:33 -04:00
2026-10-21 00:12:33 -04:00
2026-10-21 00:12:33 -04:00
2026-10-21 00:12:33 -04:00
2026-10-21 00:12:33 -04:00
2026-10-21 00:12:33 -04:00
2026-10-21 00:12:33 -04:00

Documentation index

Start with the project README.

User guide

Read in order:

  1. how-it-works.md: what the binary does, what it reads and serves, auth, lifecycle, signals, commands
  2. install.md: Nix package, NixOS module, or from source with an example systemd unit
  3. configuration.md: layers (file, env, flags), every section, validation, what reloads
  4. operations.md: tokens, MCP clients, network exposure, Docker access, OpenTelemetry, troubleshooting

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; rendered by the running binary at /docs (Redoc)
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

Contributors

Doc Contents
development.md Toolchain, tests, version stamp, OpenAPI regeneration
hooks.md Git hooks and flake checks
ARCHITECTURE.md Design, decisions, verification
TODO.md Work tracking
AGENTS.md Guidance for AI coding agents
plan/ Plans for the next big phase

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.