docs
This commit is contained in:
1 parent
d8ad1c44c5
commit
72fccc34f8
14 files changed
+811
-261
No files matched your search
@@ -12,7 +12,7 @@ Canonical guidance for AI coding agents in this repo (no CLAUDE.md; this file is
|
||||
- `tests/`, `docs/openapi.json` (generated; regenerate with `cargo run -- openapi --peers > docs/openapi.json`), `examples/`, `migrations/`, `dev/otelcol.yaml`, `systemd/` (example unit), `flake.nix` + `nix/` (package, NixOS module, VM test), `config.example.toml`
|
||||
- [`ARCHITECTURE.md`](ARCHITECTURE.md): design, decisions (DEC-n), gotchas, verification checklist. Read before structural changes.
|
||||
- [`TODO.md`](TODO.md): all work tracking. [`plan/`](plan/README.md): plans for the next big phase only. [`docs/`](docs/README.md): long-form docs, archived workstream records.
|
||||
- [`README.md`](README.md): user-facing install and usage.
|
||||
- [`README.md`](README.md): user-facing overview; the user guide is `docs/how-it-works.md`, `install.md`, `configuration.md`, `operations.md` (development notes in `docs/development.md`).
|
||||
|
||||
## Commands
|
||||
|
||||
@@ -47,7 +47,7 @@ Git hooks run fmt, clippy, lint and a secret scan on commit and path-filtered te
|
||||
- Default port is 1984, default bind is loopback. Do not change defaults for convenience.
|
||||
- Comments: sparse, explain why not what. No workstream, task or review tags (`WS-x`, `G3`, `DEC-n`) in code comments; reference ARCHITECTURE.md by section if needed.
|
||||
- The MCP tool count is 8 without peers and 10 with `peers.enabled` (`list_peers`, `get_peer`, and an optional `peer` argument on the other eight); the tool-list snapshot test guards both tables. Change tools deliberately.
|
||||
- Keep `config.example.toml` and `README.md` in sync with config or CLI changes.
|
||||
- Keep `config.example.toml`, `docs/configuration.md` and `docs/how-it-works.md` (command list) in sync with config or CLI changes; NixOS option changes go in `docs/install.md`.
|
||||
|
||||
## Safety
|
||||
|
||||
@@ -67,6 +67,6 @@ Git hooks run fmt, clippy, lint and a secret scan on commit and path-filtered te
|
||||
|
||||
1. `devenv shell -- dev-test all` (fmt, clippy, unit and integration tests) passes; that is `cargo fmt --check`, `cargo clippy --all-targets -- -D warnings` and `cargo test`.
|
||||
2. New behaviour has tests (fakes for handlers and tools; `tests/` for end to end).
|
||||
3. Docs updated: `README.md`, `config.example.toml`, `ARCHITECTURE.md` as relevant.
|
||||
3. Docs updated: `README.md`, the guides in `docs/`, `config.example.toml`, `ARCHITECTURE.md` as relevant.
|
||||
4. `TODO.md` updated; any deferred work is in the Backlog with a reason.
|
||||
5. No new openssl, no write path to the host, no secrets in the diff.
|
||||
Reference in new issue
Block a user