Skip to content

docs: document node-claim guard and provider subscriptions - #104

Merged
kjgbot merged 2 commits into
mainfrom
docs/node-claim-guard-and-subscriptions
Sep 19, 2026
Merged

kjgbot merged 2 commits into
mainfrom
docs/node-claim-guard-and-subscriptions

Conversation

@AgentRelayBot

@AgentRelayBot AgentRelayBot commented Sep 19, 2026

Copy link
Copy Markdown
Contributor

Summary

Docs for two shipped behaviors that had none.

  • Node-claim guard (relay 12.3.0, relay#1801): node up refuses a second local broker for an already-claimed node id. New 'One broker per enrolled node' section in Broker lifecycle, --force in the flag table, cross-link from Nodes → Enrollment And Identity.
  • Provider subscriptions (integration subscribe, relay#1756): new page under Automation — bind a provider resource to @agent/#channel, events land in the Relayfile tree and wake the recipient, queued events replay on reconnect. Pointer added from Webhooks.

Test plan

  • /docs/provider-subscriptions renders with the nav entry
  • Accuracy check against relay 12.3.0 changelog and relaycast 8.11.4 semantics

Generated with Devin


Note

Low Risk
Documentation-only changes with no runtime, auth, or data-path modifications.

Overview
Documents two previously undocumented relay behaviors and wires them into the docs site.

Broker lifecycle gains a --force flag in the node up table and a new One broker per enrolled node section: machine-local claims under ~/.agentworkforce/relay/node-claims/, refusal when a second broker targets the same enrolled id, and how --force / node down handle takeover and stale claims. Nodes → Enrollment And Identity now points readers at that section.

A new Provider subscriptions page under Automation covers agent-relay integration subscribe / unsubscribe: binding GitHub (and similar) resources to @agent or #channel, Relayfile paths and wake messages, --spawn, durable replay on reconnect, and list/unsubscribe. Webhooks clarifies that provider integrations are not webhooks and links here. docs-nav adds the page under Automation.

Reviewed by Cursor Bugbot for commit aa9bc74. Bugbot is set up for automated code reviews on this repo. Configure here.

Cover two behaviors that shipped without docs:

- agent-relay 12.3.0's machine-local enrollment claim: `node up` now
  refuses a second broker for an already-claimed node id (with `--force`
  as the deliberate takeover), documented on the broker lifecycle page
  and cross-linked from Nodes → Enrollment And Identity.
- `agent-relay integration subscribe` as a user-facing recipe: bind a
  provider resource to an agent/channel, events materialize through
  Relayfile and wake the recipient, deliveries queue and replay across
  reconnects. New page under Automation with a pointer from Webhooks.

Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Sep 19, 2026

Copy link
Copy Markdown
Contributor

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 8301846a-9eec-492c-a1a9-549d5607f2d6


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Sep 19, 2026

Copy link
Copy Markdown
Contributor

Preview deployed!

Environment URL
Web https://79229b97-agentrelay-web.agent-workforce.workers.dev

This is a Cloudflare Workers preview version of this PR's build.

Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@kjgbot
kjgbot merged commit 880d2d5 into main Sep 19, 2026
5 checks passed
@kjgbot
kjgbot deleted the docs/node-claim-guard-and-subscriptions branch September 19, 2026 21:51
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