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

docs: sort the top-level directories into five sections by what the reader wants

Browse source 
Every docs directory moves under 1-getting-started, 2-handbook,
4-implementation or 5-project; the options reference (section 3) comes from
the website and has no directory here. trust-boundary stays whole under the
handbook for now. web-ui, swarm and tools split between handbook and
implementation, and the command-line references move to
2-handbook/reference. Links, path references in code and nix, and the docs
index follow the moves; no page content changes.
This commit is contained in:
iris 2026-11-06 18:30:12 +01:00 • committed by mara
commit 6739bb903d
2 changed files with 736 additions and 701 deletions
Download patch file Download diff file Expand all files Collapse all files

4
hive-c0re/src/lifecycle/host_config.rs
View file

@ -289,7 +289,7 @@ async fn systemd_daemon_reload() -> Result<()> {
}
/// Append the bind flag for `child`'s `state` dir into `binds`. See
/// docs/agent-lifecycle/persistence.md ("Cross-agent access to state") for what
/// docs/2-handbook/agent-lifecycle/persistence.md ("Cross-agent access to state") for what
/// the holder may touch and why. Creates the missing host-side directory so
/// nspawn doesn't refuse to start; a missing dir is non-fatal.
///
@ -362,7 +362,7 @@ fn holds_manage_root_agent(agent_name: &str, path: &Path) -> bool {
/// that hive-c0re owns: `PRIVATE_NETWORK` (always 1), `HOST_ADDRESS` (the
/// bridge gateway IP) and `EXTRA_NSPAWN_FLAGS` (the runtime-dir bind). What
/// those network vars mean and why isolation is unconditional:
/// `docs/networking/network.md` § *What the Rust side does*.
/// `docs/4-implementation/networking/network.md` § *What the Rust side does*.
///
/// ⚠️ The start script expands `$EXTRA_NSPAWN_FLAGS` unquoted into the
/// `systemd-nspawn` command.

4
hive-c0re/src/lifecycle/mod.rs
View file

@ -47,7 +47,7 @@ pub use hive_meta_flake::agent_web_port;
///
/// `HIVE_NETWORK_SUBNET` carries the host-side bridge address verbatim
/// (e.g. `10.42.0.1/24`), **not** the canonical network address — see
/// the note in `set_nspawn_flags` + `docs/networking/network.md`. The IP part is
/// the note in `set_nspawn_flags` + `docs/4-implementation/networking/network.md`. The IP part is
/// therefore the bridge IP itself: the host end of the bridge, the
/// default-route target for isolated containers, and the address the
/// hive dnsmasq resolver binds. Returns the dotted-decimal IP with the
@ -436,7 +436,7 @@ pub async fn converge_start_preamble(
/// activation-error shape), retry once via stop + kill + start before
/// giving up. Used by the queue's fast-lane `Start` handler and the
/// inline start-after-rebuild path.
/// See `docs/scheduler/coordinator.md::Cold-start fallback`.
/// See `docs/4-implementation/scheduler/coordinator.md::Cold-start fallback`.
///
/// Requires a [`StartableAgent`] token from [`converge_start_preamble`]
/// to prove the preamble ran. For internal use within this module (where