mara/hyperhive
mara/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Activity

docs: move the cli references under 2-handbook/tools

Browse source 
Closes #6157
This commit is contained in:
atlas 2026-11-06 22:59:11 +01:00 • committed by mara
commit df8a82bc33
1 changed files with 54 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/5-project/process/conventions.md
View file

@ -497,20 +497,20 @@ mara — don't add `#[allow]` speculatively. The gate is intentional.
fmt / `cargo test` cover most gates, but `nix flake check` runs extra
check derivations they don't:
- **`hivectl-docs`** regenerates `docs/2-handbook/reference/hivectl-cli.md` from
- **`hivectl-docs`** regenerates `docs/2-handbook/tools/hivectl-cli.md` from
hivectl's clap tree and **fails if the committed copy is stale**.
**After any change to a hivectl verb or flag, regenerate it**:
```sh
nix develop -c cargo run --bin hivectl -- markdown-docs > docs/2-handbook/reference/hivectl-cli.md
nix develop -c cargo run --bin hivectl -- markdown-docs > docs/2-handbook/tools/hivectl-cli.md
```
clippy / fmt / `cargo test` all pass *without* this — only the
flake check catches the drift, and `ci-log` often can't show you
why (it 500s on a fast failure), so you're left guessing "builder
flake" when it's a stale doc.
- **`swarmctl-docs`** is the same check for `swarmctl` /
`docs/2-handbook/reference/swarmctl-cli.md`:
`docs/2-handbook/tools/swarmctl-cli.md`:
```sh
nix develop -c cargo run --bin swarmctl -- markdown-docs > docs/2-handbook/reference/swarmctl-cli.md
nix develop -c cargo run --bin swarmctl -- markdown-docs > docs/2-handbook/tools/swarmctl-cli.md
```
- there's also a flake `cargo-test` check and NixOS module
evaluation in the set.