mara/hyperhive
mara/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Activity
hyperhive/docs
History
Repository files (latest commit first)
Filename Latest commit message Latest commit date
iris 97671e28d5 docs: move implementation sections out of the handbook pages 
Three handbook pages carried sections an operator never reads, named after
source paths and build internals. They move to pages under 4-implementation,
and each handbook page keeps a short pointer.

- forge.md: the notification poller (what it polls, how it formats,
  de-duplicates and marks notifications read) is now
  agent-tools/forge-notify.md. The forge page keeps a short Notifications
  section.
- matrix.md: the retired hive-side matrix code, the evaluation assertions and
  the fluffychat-web build fixes are now networking/matrix-homeserver.md.
- github.md: the Implementation section (how `gh` and `git push`
  authenticate, and the GitHub poller) is now agent-tools/github.md.

docs/README.md and the agent-tools README list the new pages, and AGENTS.md's
note on mixed operator and implementation docs now says to move the detail
and leave a pointer.
2026-11-09 21:27:43 +01:00
..
1-getting-started docs: use neutral placeholder agent names in examples 2026-11-09 21:09:18 +01:00
2-handbook docs: move implementation sections out of the handbook pages 2026-11-09 21:27:43 +01:00
4-implementation docs: move implementation sections out of the handbook pages 2026-11-09 21:27:43 +01:00
5-project drop the host side of the agent broker send 2026-11-08 08:56:39 +01:00
README.md docs: move implementation sections out of the handbook pages 2026-11-09 21:27:43 +01:00

README.md

hyperhive docs

Depth reference for hyperhive — the substrate, not the pitch (that's the top-level README / website). Every page here stands alone; pick the one matching your task rather than reading top to bottom. The docs sit in five sections, by what the reader wants:

  1. Getting started: what hyperhive is, and how to bring one up.
  2. Handbook: running and using a hive and a swarm.
  3. Options reference: every NixOS option.
  4. Implementation: how it works inside.
  5. Project: how the project itself works.

1. Getting started

2. Handbook

Using and operating hyperhive, in the three layers that make it up, plus the accounts an agent can hold outside it. Some pages here still carry implementation detail next to the operator content; sorting those out is later work.

Swarm

The services that exist once per swarm. Start at 2-handbook/swarm/.

Hives

The host a hive runs on and the operator's tools for it. Start at 2-handbook/hives/.

Agents

One agent: its roster entry, state, config and page. Start at 2-handbook/agents/.

External accounts

Accounts outside the swarm that an agent can hold. Start at 2-handbook/external-accounts/.

3. Options reference

The autogenerated NixOS options reference (every services.hyperhive.* / hyperhive.* option, host and agent) lives on the website, built from the module declarations: the options site. Nothing of it sits in this tree.

4. Implementation

Agent tools

Turn loop, scheduler, CI, observability

Networking

Swarm services

Trust boundary mechanics

Web UI internals

Crate reference

  • What does a specific Rust crate do, on its own terms? → 4-implementation/crates/ — every workspace crate's own README.md, one level up from source; the crate itself is still the source of truth, this is just a walkable mirror.

5. Project

How the project itself works: processes, conventions, design guides.