32 lines
1.8 KiB
Markdown
32 lines
1.8 KiB
Markdown
# Documentation index
|
|
|
|
Root files: [`README.md`](../README.md) (install and usage), [`ARCHITECTURE.md`](../ARCHITECTURE.md) (design, decisions, verification), [`TODO.md`](../TODO.md) (work tracking), [`AGENTS.md`](../AGENTS.md) (guidance for AI coding agents). Plans for the next big phase go in [`plan/`](../plan/README.md).
|
|
|
|
## Reference
|
|
|
|
| Doc | Contents |
|
|
|---|---|
|
|
| [`api.md`](api.md) | Full REST route table, MCP tools/prompts/resources, client setup, Origin and Host checks |
|
|
| [`openapi.json`](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`](tls.md) | Native TLS: configuration, self-signed example, SIGHUP rotation, ACME and sops paths |
|
|
|
|
## Workstream records (archived)
|
|
|
|
> **Archived.** The files in [`workstreams/`](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`](../ARCHITECTURE.md) and open work is in [`TODO.md`](../TODO.md).
|
|
|
|
| Card | Phase | Depends on |
|
|
|---|---|---|
|
|
| [P0 Foundation](workstreams/P0-foundation.md) | 0 | none |
|
|
| [WS-A systemd](workstreams/WS-A-systemd.md) | 1 | P0 |
|
|
| [WS-B journal](workstreams/WS-B-journal.md) | 1 | P0 |
|
|
| [WS-C docker](workstreams/WS-C-docker.md) | 1 | P0 |
|
|
| [WS-D auth + DB](workstreams/WS-D-auth.md) | 1 | P0 |
|
|
| [WS-E REST](workstreams/WS-E-rest.md) | 2 | A, B, C, D |
|
|
| [WS-F MCP](workstreams/WS-F-mcp.md) | 2 | A, B, C, D |
|
|
| [WS-G OTel](workstreams/WS-G-otel.md) | 2 | A, B, C |
|
|
| [P3 Integration](workstreams/P3-integration.md) | 3 | E, F, G |
|
|
| [WS-I TLS](workstreams/WS-I-tls.md) | 4 | P3 |
|
|
| [WS-H NixOS](workstreams/WS-H-nixos.md) | 4 | P3, WS-I (gate result pending) |
|
|
|
|
Dependency order: P0, then A to D in parallel, then E to G in parallel, then P3, then WS-I, then WS-H.
|