54 lines
3.6 KiB
Markdown
54 lines
3.6 KiB
Markdown
# Workboard
|
|
|
|
Markdown workboard for building skyg-linux-tracker (CLI: `slinuxm`). The design lives in [`../plan.md`](../plan.md). This folder tracks the work.
|
|
|
|
| File | Purpose |
|
|
|---|---|
|
|
| [`BOARD.md`](BOARD.md) | Kanban view. One row per workstream card, moved between columns. |
|
|
| [`../TODO.md`](../TODO.md) | Master checklist. The only place task checkboxes are ticked. |
|
|
| [`workstreams/`](workstreams/) | One card per workstream: goal, owned files, dependencies, design notes, done criteria, log. |
|
|
| [`review.md`](review.md) | Design review of `plan.md`. Corrections and gaps, each mapped to a task. |
|
|
| [`decisions.md`](decisions.md) | Decision log. Open questions and proposed defaults. |
|
|
|
|
## Cards
|
|
|
|
| Card | Phase | Depends on | Owned files |
|
|
|---|---|---|---|
|
|
| [P0 Foundation](workstreams/P0-foundation.md) | 0 | — | `Cargo.toml`, `devenv.nix`, `config.example.toml`, `src/main.rs`, `src/config.rs`, `src/error.rs`, `src/state.rs`, `src/sources/mod.rs`, `src/sources/fake.rs`, all stubs |
|
|
| [WS-A systemd](workstreams/WS-A-systemd.md) | 1 | P0 | `src/sources/systemd.rs`, `examples/systemd_dump.rs` |
|
|
| [WS-B journal](workstreams/WS-B-journal.md) | 1 | P0 | `src/sources/journal.rs`, `examples/journal_tail.rs` |
|
|
| [WS-C docker](workstreams/WS-C-docker.md) | 1 | P0 | `src/sources/docker.rs`, `examples/docker_ps.rs` |
|
|
| [WS-D auth + DB](workstreams/WS-D-auth.md) | 1 | P0 | `src/db.rs`, `src/auth/`, `migrations/` |
|
|
| [WS-E REST](workstreams/WS-E-rest.md) | 2 | P0 (fakes); A, B, C, D to finish | `src/api/` |
|
|
| [WS-F MCP](workstreams/WS-F-mcp.md) | 2 | P0 (fakes); A, B, C, D to finish | `src/mcp/` |
|
|
| [WS-G OTel](workstreams/WS-G-otel.md) | 2 | P0 (fakes); A, B, C to finish | `src/telemetry/`, `dev/otelcol.yaml` |
|
|
| [P3 Integration](workstreams/P3-integration.md) | 3 | E, F, G | `src/main.rs` (wiring), `systemd/`, `README.md`, `tests/` |
|
|
| [WS-H NixOS](workstreams/WS-H-nixos.md) | 4 | P3 | `flake.nix`, `nix/` |
|
|
|
|
## Dependency graph
|
|
|
|
```
|
|
P0 Foundation (config, DTOs, traits+fakes, AppState, stubs)
|
|
├── WS-A systemd ──┐
|
|
├── WS-B journal ──┤
|
|
├── WS-C docker ───┼──► WS-E REST ──┐
|
|
└── WS-D auth ─────┤ WS-F MCP ───┼──► P3 Integration
|
|
└──► WS-G OTel ──┘
|
|
|
|
P3 Integration ──► WS-H NixOS (package + module + CLI wrapper + VM test)
|
|
```
|
|
|
|
With source traits and fakes (DEC-2), Phase 2 cards can **start** as soon as P0 is done. They **finish** only once their real sources are merged and verified against a live host.
|
|
|
|
**Solo order:** P0 → A → B → C → D → E → F → G → P3.
|
|
|
|
## Rules
|
|
|
|
1. **Status flow:** `Backlog` → `Ready` → `In progress` → `Review` → `Done`, plus `Blocked` with a reason. A card becomes `Ready` when everything in its "Depends on" is `Done`, or when it can run against fakes.
|
|
2. **One owner per card.** Put the name (or agent/branch) in the card's Owner field and on the board.
|
|
3. **File ownership is strict.** A card edits only its owned files. If it needs a change in someone else's file, typically a DTO in `src/sources/mod.rs`, raise it in the card log and make the change as a small separate commit agreed with that file's owner.
|
|
4. **Tick tasks in `TODO.md`.** Cards describe tasks but do not carry checkboxes, so there is one source of truth.
|
|
5. **A card moves to `Done`** when every task is ticked, its "Done when" criteria are demonstrated, and `cargo clippy -- -D warnings` + `cargo test` pass.
|
|
6. **Decisions go in `decisions.md`.** Record the outcome there and link it from the card log.
|
|
7. **Branch naming:** `ws-a/systemd-source`, `p0/foundation`, and so on.
|