docs
This commit is contained in:
1 parent
d8ad1c44c5
commit
72fccc34f8
14 files changed
+811
-261
No files matched your search
+21
-1
@@ -1,6 +1,15 @@
|
||||
# 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).
|
||||
Start with the project [README](../README.md).
|
||||
|
||||
## User guide
|
||||
|
||||
Read in order:
|
||||
|
||||
1. [`how-it-works.md`](how-it-works.md): what the binary does, what it reads and serves, auth, lifecycle, signals, commands
|
||||
2. [`install.md`](install.md): Nix package, NixOS module, or from source with an example systemd unit
|
||||
3. [`configuration.md`](configuration.md): layers (file, env, flags), every section, validation, what reloads
|
||||
4. [`operations.md`](operations.md): tokens, MCP clients, network exposure, Docker access, OpenTelemetry, troubleshooting
|
||||
|
||||
## Reference
|
||||
|
||||
@@ -11,6 +20,17 @@ Root files: [`README.md`](../README.md) (install and usage), [`ARCHITECTURE.md`]
|
||||
| [`tls.md`](tls.md) | Native TLS: configuration, self-signed example, SIGHUP rotation, ACME and sops paths |
|
||||
| [`consolidator.md`](consolidator.md) | Peers (consolidator): config, agenix tokens, threat model, firewall, reload |
|
||||
|
||||
## Contributors
|
||||
|
||||
| Doc | Contents |
|
||||
| -------------------------------------- | ------------------------------------------------------------ |
|
||||
| [`development.md`](development.md) | Toolchain, tests, version stamp, OpenAPI regeneration |
|
||||
| [`hooks.md`](hooks.md) | Git hooks and flake checks |
|
||||
| [`ARCHITECTURE.md`](../ARCHITECTURE.md) | Design, decisions, verification |
|
||||
| [`TODO.md`](../TODO.md) | Work tracking |
|
||||
| [`AGENTS.md`](../AGENTS.md) | Guidance for AI coding agents |
|
||||
| [`plan/`](../plan/README.md) | Plans for the next big phase |
|
||||
|
||||
## 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).
|
||||
|
||||
Reference in new issue
Block a user