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.
49 lines
2.2 KiB
Markdown
49 lines
2.2 KiB
Markdown
# hive-c0re
|
|
|
|
The unprivileged host daemon (runs as `hive-core`). Owns the sqlite
|
|
broker, the approval/reminder/schedule queues, the generic job-DAG
|
|
queue, container lifecycle, gateway/forge/matrix provisioning,
|
|
per-container stats, and the axum operator dashboard. Largest crate in
|
|
the workspace — bin-only, no separate lib.
|
|
|
|
## When to use it
|
|
|
|
Host-level, cross-container orchestration: spawning/rebuilding/
|
|
destroying agent containers, the approval flow, dashboard-visible
|
|
state, provisioning per-agent forge/matrix/gateway accounts. Agent-side
|
|
behavior (turn loop, MCP tools) lives in `hive-agent`/`hive-agent-mcp`
|
|
instead — this daemon only talks to agents over the socket wire types
|
|
in `hive-sh4re`.
|
|
|
|
## Shape
|
|
|
|
Cohesive clusters live in directory submodules, each re-exported at
|
|
the crate root (`crate::broker::…` keeps resolving regardless of which
|
|
subdirectory a module actually lives in). One line each — read the
|
|
module's own `//!` doc-comment for real detail, don't expect this file
|
|
to track it:
|
|
|
|
- **`dashboard/`** — the operator dashboard (containers, approvals,
|
|
schedules, logs, topology).
|
|
- **`job_queue/`** — the job-DAG queue + desired-state reconciliation
|
|
(`docs/scheduler/coordinator.md`).
|
|
- **`lifecycle/`** — `nixos-container` lifecycle + per-agent config
|
|
flake generation.
|
|
- **`stores/`** — sqlite-backed stores (broker, queues, audit, power).
|
|
- **`workers/`** — background sweeps (crash watch, scheduled prompts,
|
|
auto-update, knowledge sync).
|
|
- **`agent_config/`** — per-agent registries (tool groups,
|
|
capabilities, resource limits, topology).
|
|
- **`stats/`** — dashboard metrics aggregation + OTEL export.
|
|
- **`socket_server/`** — the unix-socket request server shared by
|
|
per-agent + manager sockets.
|
|
- **`forge/`** — optional Forgejo wiring (`docs/integrations/forge.md`).
|
|
- **`coordinator.rs`** — top-level wiring for `serve`.
|
|
- **`meta.rs`**, **`migrate.rs`** — the meta flake + schema/state
|
|
migrations.
|
|
- **`matrix.rs`**, **`gateway_nginx.rs`**, **`webhook_secret.rs`**,
|
|
**`priv_client.rs`** — matrix provisioning, gateway vhosts, webhook
|
|
secrets, and the `hive-priv` client respectively.
|
|
|
|
See the top-level `CLAUDE.md`/`docs/` index for the full reading-path
|
|
map.
|