Skip to content

docs: front doors for node operators and publishers - #135

Merged
thiras merged 2 commits into
mainfrom
docs/persona-front-doors
Oct 10, 2026
Merged

thiras merged 2 commits into
mainfrom
docs/persona-front-doors

Conversation

@thiras

@thiras thiras commented Oct 10, 2026

Copy link
Copy Markdown
Contributor

Summary

The last PR of the persona restructure. It is stacked on #134, and its text describes #131 (Compose origin profile) and #132 (chart origin docs), so merge it after all of them.

  • docs/node-operators.md. What a cache node is and the entry point on each deploy path. A miss is filled from other nodes and paid from the node's own pool (ADR 003). It also covers the on-chain stake and registration step (ADR 019) and the caveats of moving to self-hosted relays or discovery.
  • docs/publishers.md.
    • Who a publisher is (ADR 002), with the CLI steps: decdn publish namespace create / assign / revoke, and decdn origin import.
    • The four services: origin, sponsord + onramp, iroh relay, iroh DNS server. Each comes with its group, playbook and the other paths it runs on.
    • How an origin differs from a cache node:
    • Relay allowlist and DNS caveats, and that decommissioning an origin leaves it seated.
  • README opens on the two personas. AGENTS.md "What this repo is" describes the persona entry points. requirements.md and lifecycle.md gain the origin notes.

A fact-check pass against the ADRs and the code corrected one claim. The relay_foreign_namespaces gate depends on the node's backend, not on the namespace. That wording was also fixed in #133, #131 and #132.

Test plan

  • make lint (markdownlint)
  • make test-scripts and make lint-cloud-init on the full stack
  • Every cited ADR anchor checked against the upstream headings

🤖 Generated with Claude Code

Copilot AI balanced review requested due to automatic review settings October 10, 2026 16:31

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The new guides misdescribe PaymentPool spending and origin import behavior, and contain invalid role paths.

5 open findings
What changed in this PR

Adds persona-based documentation front doors for node operators and publishers.

Changes:

  • Documents cache-node and publisher workflows across deployment paths.
  • Clarifies origin lifecycle, relay, discovery, and on-chain requirements.
  • Updates repository navigation and contributor guidance.
File Description
README.md Adds persona-based entry points.
AGENTS.md Documents persona-specific deployment structure.
docs/​node-operators.md Adds the cache-node operator guide.
docs/​publishers.md Adds the publisher and origin guide.
docs/​requirements.md Applies requirements to cache and origin nodes.
docs/​lifecycle.md Documents origin decommissioning.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/node-operators.md Outdated
Comment thread docs/node-operators.md Outdated
Comment thread docs/publishers.md Outdated
Comment thread docs/publishers.md Outdated
Comment thread docs/publishers.md Outdated
@thiras
thiras force-pushed the feat/cloud-init-personas branch from 1818a58 to 799ba39 Compare October 10, 2026 16:45
@thiras
thiras force-pushed the docs/persona-front-doors branch from 7bdcd3e to 0462622 Compare October 10, 2026 16:46
@thiras
thiras force-pushed the feat/cloud-init-personas branch from 799ba39 to c2c5729 Compare October 10, 2026 17:10
@thiras
thiras force-pushed the docs/persona-front-doors branch from 0462622 to e691397 Compare October 10, 2026 17:10
@thiras
thiras force-pushed the feat/cloud-init-personas branch from c2c5729 to 88accfa Compare October 10, 2026 17:38
@thiras
thiras force-pushed the docs/persona-front-doors branch from e691397 to 5eca3d4 Compare October 10, 2026 17:38
Base automatically changed from feat/cloud-init-personas to main October 10, 2026 18:01
thiras and others added 2 commits October 10, 2026 21:01
docs/node-operators.md and docs/publishers.md are the two entry points:
what each kind of operator runs, on which deploy path and entry point,
and the on-chain steps that are theirs, every protocol claim cited to an
ADR. A node operator runs cache nodes, which pay for their misses from
their own pool; a publisher runs origin nodes (served from their own
backend, seated with `decdn publish assign`) and optionally sponsord, iroh
relays and an iroh DNS server. The README opens on that split, AGENTS.md
describes the persona entry points, and lifecycle.md says decommissioning
an origin leaves it seated until the publisher revokes it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ore, and role links resolve

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@thiras
thiras force-pushed the docs/persona-front-doors branch from 5eca3d4 to 5e064f5 Compare October 10, 2026 18:01
@thiras
thiras merged commit 549fe63 into main Oct 10, 2026
17 checks passed
@thiras
thiras deleted the docs/persona-front-doors branch October 10, 2026 18:05
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.

2 participants