Skip to content

docs: humds peer through the relay mesh, and hives grow under groves - #109

Merged
adiled merged 1 commit into
mainfrom
docs-relay-orchd-0.5
Nov 12, 2026
Merged

adiled merged 1 commit into
mainfrom
docs-relay-orchd-0.5

Conversation

@adiled

@adiled adiled commented Nov 12, 2026

Copy link
Copy Markdown
Owner

Brings the docs in line with #107 (relay peering, 0.34.3) and #108 (orchd 0.5 / Orch 0.3, 0.35.0).

  • ensemble/README.md: the NAT row, the T3 transport and the daemon line now describe the n0 relay and DNS lookup. The iroh quick-tour example shows an iroh-relay: hint and explains that iroh: alone is enough. The "relay path is unproven" gap is removed, citing tests/iroh_relay.rs.
  • THRUM.md: the iroh transport goes through the relay mesh; it isn't direct-only.
  • hum/README.md, hum-paths/README.md, man/hum.1: the hint lists include iroh-ip: and iroh-relay:.
  • hives/README.md, plus the ollama-server, dwarfstar and apple-fm READMEs: hives grow in a grove, not a namespace, and orch sits beside orchd.
  • man/hum.1: the installed binaries include orch and the rootstocks, from orchd's release, pinned and checksum-verified.

The site pages are generated from these files by site/scripts/sync-docs.mjs, so they update on the next deploy. The README doctests pass (cargo test -p ensemble --doc), and the man page renders cleanly; the only mandoc warnings are on lines this PR doesn't touch.

The docs still described a daemon that bound direct-only, a relay path
nobody had crossed, a hint list without `iroh-relay:`, and hives grown
in orchd namespaces. hum peers through the n0 relay mesh since 0.34.3
and runs on orchd 0.5, where --grove replaced --namespace, since
0.35.0.

- ensemble/README.md: the NAT row, the T3 transport and the daemon
  line describe the relay and DNS lookup. The iroh example shows an
  `iroh-relay:` hint and says only `iroh:` is needed. The "relay path
  is unproven" gap is gone, with tests/iroh_relay.rs as the proof.
- THRUM.md: the iroh transport is the relay mesh, not direct-only.
- hum/README.md, hum-paths/README.md, man/hum.1: the hint lists carry
  `iroh-ip:` and `iroh-relay:`.
- hives/README.md and the ollama-server, dwarfstar and apple-fm
  READMEs: hives grow in a grove, beside the `orch` orchd reads
  Orchfiles through.
- man/hum.1: the installed binaries include orch and the rootstocks,
  pulled from orchd's release, pinned and checksum-verified.
@adiled
adiled merged commit 9cfe6c3 into main Nov 12, 2026
7 checks passed
@adiled
adiled deleted the docs-relay-orchd-0.5 branch November 12, 2026 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant