Watch
0
0
Fork
You've already forked hyperhive
0

docs: use neutral placeholder agent names in examples

The setup page's first-agent example named the agent iris, and a user
copied it verbatim. Use <name> there, with a line saying the name is free
to choose, and agent1/agent2 in the hivectl, schedule and label examples.
This commit is contained in:
iris 2026-11-09 20:42:51 +01:00 • committed by mara
commit da071e3fa9

View file

@ -144,18 +144,18 @@ an agent's config arrive as PRs you merge. → [`2-handbook/agents/agent-roster.
To create an agent yourself instead, use the swarm UI, or:
```bash
swarmctl agent create iris --hive firsthive
swarmctl agent create <name> --hive firsthive
```
The controller provisions iris's identity, forge user and config repo
(`agent-configs/iris`, from the default template), then has the hive build
The name is yours to choose; it has no meaning to the swarm. The controller provisions the agent's identity, forge user and config repo
(`agent-configs/<name>`, from the default template), then has the hive build
and start the container. The hive builds from a copy of hyperhive on the swarm's own forge: the
controller mirrors it there as `hyperhive/hyperhive` on a fresh swarm, so the
first agent needs no extra step (see
[`nixos.md`](nixos.md#the-hyperhive-mirror)). It returns once the scheduler queues the job — watch the
swarm UI's job view for progress.
Later config changes are PRs on `agent-configs/iris`; you merge them on the
Later config changes are PRs on `agent-configs/<name>`; you merge them on the
forge, and the merge deploys them. →
[`2-handbook/agents/config-changes.md`](../2-handbook/agents/config-changes.md#config-changes)