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
1 changed files with 736 additions and 701 deletions
Download patch file Download diff file Expand all files Collapse all files

16
hive-core-agent-sock/src/lib.rs
View file

@ -34,7 +34,7 @@ pub enum Request {
},
/// Pop pending messages from this agent's inbox.
/// Delivery + ack cycle: see
/// `docs/process/conventions.md::Broker delivery + ack cycle`.
/// `docs/5-project/process/conventions.md::Broker delivery + ack cycle`.
Recv {
#[serde(default)]
wait_seconds: Option<u64>,
@ -46,7 +46,7 @@ pub enum Request {
Status,
/// Wake-up event injected from inside the container. Recipient is
/// implicit (this agent); `from` is caller-chosen. See
/// `docs/process/conventions.md::Wake injection` for the trust model and
/// `docs/5-project/process/conventions.md::Wake injection` for the trust model and
/// typical callers. The wake is persisted in the sqlite broker
/// like any other message — the agent can ack it via `AckUntil`.
Wake { from: String, body: String },
@ -55,7 +55,7 @@ pub enum Request {
/// per-agent web UI uses this to render its own inbox section.
Recent { limit: u64 },
/// Loose-ends view — always the caller's own. See
/// `docs/process/conventions.md::Loose-ends wire shape`.
/// `docs/5-project/process/conventions.md::Loose-ends wire shape`.
GetLooseEnds,
/// Set a free-text status string visible on the dashboard. The harness
/// writes `{state_dir}/hyperhive-status` locally before sending this
@ -64,14 +64,14 @@ pub enum Request {
SetStatus { text: String },
/// Fetch identity + status for an agent. `name = None` =
/// self-introspection; `Some(<agent>)` = target query. See
/// `docs/process/conventions.md::Agent metadata`.
/// `docs/5-project/process/conventions.md::Agent metadata`.
GetAgentMeta {
#[serde(default, skip_serializing_if = "Option::is_none")]
name: Option<Ident>,
},
/// Mark every message popped since the last `AckTurn` as handled.
/// Harness↔broker pairing fired after `TurnOutcome::Ok`. See
/// `docs/process/conventions.md::Broker delivery + ack cycle`.
/// `docs/5-project/process/conventions.md::Broker delivery + ack cycle`.
AckTurn,
/// Mark every inbox message with broker row id `<= up_to` as
/// handled (`acked_at` set), whether still pending or already
@ -80,12 +80,12 @@ pub enum Request {
/// re-reading dozens of already-handled messages one turn at a
/// time, the agent acks everything up to the id it has seen.
/// Recipient-scoped — an agent can only ack its own rows. See
/// `docs/process/conventions.md::Broker delivery + ack cycle`.
/// `docs/5-project/process/conventions.md::Broker delivery + ack cycle`.
AckUntil { up_to: i64 },
/// Requeue every popped-but-unacked message back into the inbox.
/// Harness fires this once at boot to recover from
/// crashed-mid-turn sessions. See
/// `docs/process/conventions.md::Broker delivery + ack cycle`.
/// `docs/5-project/process/conventions.md::Broker delivery + ack cycle`.
RequeueInflight,
/// Harness → c0re: "I saw the `GracefulStop` signal, ran my
/// stop-checkpoint turn (durable `/state` flushed) and am exiting my
@ -146,7 +146,7 @@ pub enum Response {
/// this agent. Ordered newest-first within each kind.
LooseEnds { loose_ends: Vec<LooseEnd> },
/// `GetAgentMeta` result. Per-field semantics + serde defaults
/// live in `docs/process/conventions.md::Agent metadata`.
/// live in `docs/5-project/process/conventions.md::Agent metadata`.
AgentMeta {
name: String,
#[serde(default = "default_true")]