07b62612b0
Per mara's go-ahead on hyperhive#3902 ("getting started is good, but
terminal rendering does not go in there i think"):
Moved 21 top-level docs/*.md files into 7 new topic subdirectories
(existing web-ui/, turn-loop/, swarm/, tools/, crates/ untouched):
getting-started/ setup.md
agent-lifecycle/ agent-hierarchy.md, approvals.md, persistence.md
trust-boundary/ boundary.md, security.md
integrations/ forge.md, matrix.md, github.md, knowledge.md
networking/ gateway.md, network.md, snapshot-store.md
scheduler/ jobq.md, coordinator.md, ci.md, observability.md
process/ conventions.md, gotchas.md, pr-review-gate.md
web-ui/ terminal-rendering.md (moved into the EXISTING dir,
per mara's correction to the original getting-started
guess -- it's UI implementation detail, not onboarding)
The physical layout now matches docs/README.md's own topical headers,
which already amounted to this taxonomy -- see the scoping comment on
the issue for the two findings that motivated this (a genuine
duplication between CLAUDE.md's old "Reading paths" list and
docs/README.md's grouped one, since drifted out of sync with each
other; and the flat layout not matching the grouping we already had).
Fixed every cross-reference this moved across the whole repo (~120
files: docs/ internal links at every depth, Rust doc comments, nix
module option docs, crate READMEs) -- verified two ways: a grep sweep
confirming zero remaining references to any old path, and a script
that resolves every markdown link in docs/**/*.md + CLAUDE.md +
README.md against the filesystem and reports anything that doesn't
exist (zero broken links).
Collapsed CLAUDE.md's "Reading paths" section (the duplicate) down to
a pointer at docs/README.md, now the single index. Rewrote
docs/README.md itself to use the new subdirectory paths and added the
one doc it was missing that CLAUDE.md's old copy had (pr-review-gate.md).
Classified all 22 docs/*.md files first via a haiku subagent (mara's
suggestion) on two axes -- proposed grouping and operator-vs-
implementation focus -- before finalizing the taxonomy; spot-checked
the report and found internal inconsistencies (its classification
table disagreed with its own summary section for a few files), so this
taxonomy is my original proposal + the one correction mara gave
directly, not a blind application of the subagent's table. The
operator-focus data it gathered is still useful for a follow-up
content pass (docs skewing 'mixed' rather than pure operator-facing),
not addressed in this PR -- structure only.
nix fmt clean, both pre-push lints clean.
30 lines
1.3 KiB
Markdown
30 lines
1.3 KiB
Markdown
# hive-host-sock
|
|
|
|
Wire types for the **host admin socket** (`/run/hyperhive/host.sock`) — the
|
|
host-control protocol spoken between the `hivectl` operator CLI and the
|
|
`hive-c0re` daemon.
|
|
|
|
## Why it's its own crate
|
|
|
|
Re-homed out of `hive-sh4re` so a standalone `hivectl` depends on **just this
|
|
protocol crate** instead of the whole daemon-shared crate. `hivectl` drives the
|
|
full hive (spawn / kill / destroy / rebuild / deploy) over this socket without
|
|
linking `hive-c0re`; keeping the request/response shapes here is what makes that
|
|
thin dependency possible.
|
|
|
|
## Shape
|
|
|
|
Serde-derived request/response enums for the host admin protocol. The larger
|
|
shared payload types some variants reference (`Approval`, `AgentStatusRow`)
|
|
stay in `hive-sh4re` — this crate is only the protocol envelope, no server or
|
|
client implementation.
|
|
|
|
Its own `jobs` module is the exception: the job-queue vocabulary `hivectl`
|
|
needs (`Source`, `State`, `PermPayload`, `NodeId`) is protocol-local. The typed
|
|
`DagView`/`NodeView` projection that used to live there is gone — the queue is
|
|
served as a generic graph (`hive-jobq-wire`), not as a second hand-written
|
|
view.
|
|
|
|
See `docs/trust-boundary/boundary.md` (host admin socket access) for the trust model around who
|
|
may connect to the socket, and `hive-priv-sock` for the sibling split on the
|
|
privileged-helper socket.
|