Skip to content

docs(fleets): add Fleets setup page#1136

Merged
willwashburn merged 1 commit into
mainfrom
docs/fleet-setup
Jun 16, 2026
Merged

docs(fleets): add Fleets setup page#1136
willwashburn merged 1 commit into
mainfrom
docs/fleet-setup

Conversation

@willwashburn

@willwashburn willwashburn commented Jun 16, 2026

Copy link
Copy Markdown
Member

Adds a concise, example-driven Fleets docs page and a "Fleets" nav group.

Explains why nodes exist (agents need a host that outlives your laptop) and walks through the most common setup — a Mac mini in the workspace running Claude Code and Codex as harnesses:

  • Set up a nodedefineNode with spawn:claude / spawn:codex, then fleet serve; verify with fleet nodes / fleet status.
  • Spawn onto itquery_nodes and spawn from an agent.
  • Add actions and triggersaction(...) + onMessage(...).
  • A Note on the off-by-default fleet_nodes_enabled flag.

496 words, high signal-to-noise per review feedback. Only web/content/docs/fleets.mdx and web/lib/docs-nav.ts changed.

🤖 Generated with Claude Code

Review in cubic

Concise, example-driven guide to running agents on dedicated machines
(e.g. a Mac mini with Claude Code and Codex) instead of a laptop. Covers
defining a node, `fleet serve`, verifying registration, spawning onto it,
and adding actions/triggers. Adds a "Fleets" group to the docs nav.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@willwashburn willwashburn requested a review from khaliqgant as a code owner June 16, 2026 06:40
@gemini-code-assist

Copy link
Copy Markdown

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Adds web/content/docs/fleets.mdx, a new documentation page covering Fleets (dedicated long-lived fleet nodes), including setup, fleet_nodes_enabled flag, fleet serve usage, MCP-based agent spawning, typed actions, and message triggers. Registers a matching top-level "Fleets" navigation group in docsNav.

Changes

Fleets Documentation

Layer / File(s) Summary
Fleets doc page content
web/content/docs/fleets.mdx
New 108-line page introducing the Fleets concept (fleet_nodes_enabled flag, one node per fleet serve), end-to-end node setup instructions, MCP tool usage (query_nodes, spawn), typed actions and flag-free trigger regex example, and a related-docs CardGroup.
docsNav Fleets group
web/lib/docs-nav.ts
Inserts a new top-level "Fleets" navigation group with a single fleets slug between "Delivery and sessions" and "Interfaces".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐇 Hop hop, a fleet takes flight,
Long-lived nodes ready day and night.
fleet serve spins up one by one,
Spawn your agents — work is done!
The nav now knows where fleets reside,
With docs to be your trusty guide. ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description provides context about the Fleets feature and explains the setup workflow, but does not follow the required template structure with Summary, Test Plan, and Screenshots sections. Restructure the description to match the template: add a Summary section explaining what the PR does, a Test Plan section with checkboxes for testing, and a Screenshots section (if applicable).
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs(fleets): add Fleets setup page' clearly summarizes the main change: adding documentation for the Fleets feature with a corresponding navigation entry.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/fleet-setup

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 and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@web/content/docs/fleets.mdx`:
- Around line 59-63: The documentation currently describes `spawn` as an MCP
tool alongside `query_nodes`, which misrepresents the architecture. Clarify that
`query_nodes` is the MCP discovery tool used to find nodes by capability, while
`spawn` is a node capability/action for launching agents on nodes (either by
name or by letting the workspace select one with the required capability).
Review and align any later sections or card copy in the document that reference
these concepts to use consistent terminology.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 1c2dc661-ae6e-483a-9c39-003b840f9d21

📥 Commits

Reviewing files that changed from the base of the PR and between 893a37f and eb1fdcb.

📒 Files selected for processing (2)
  • web/content/docs/fleets.mdx
  • web/lib/docs-nav.ts

Comment on lines +59 to +63
Agents reach the fleet through their MCP tools — no extra wiring:

- **`query_nodes`** — find nodes by capability (`which node can spawn:codex?`).
- **`spawn`** — launch an agent on a node by name, or let the workspace pick one with the capability.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Describe spawn as a node capability, not a standalone MCP tool.

The fleet spec treats spawning as node capability/action wiring; query_nodes is the MCP discovery tool. This paragraph makes spawn sound like a direct protocol primitive, which will mislead readers. Please align the later card copy with the same wording.

Suggested wording
-Agents reach the fleet through their MCP tools — no extra wiring:
-- **`query_nodes`** — find nodes by capability (`which node can spawn:codex?`).
-- **`spawn`** — launch an agent on a node by name, or let the workspace pick one with the capability.
+Agents reach the fleet through MCP discovery, and spawning is exposed as a node capability:
+- **`query_nodes`** — find nodes by capability (`which node can spawn:codex?`).
+- **`spawn` capability** — launch an agent on a node by name, or let the workspace pick one with the capability.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@web/content/docs/fleets.mdx` around lines 59 - 63, The documentation
currently describes `spawn` as an MCP tool alongside `query_nodes`, which
misrepresents the architecture. Clarify that `query_nodes` is the MCP discovery
tool used to find nodes by capability, while `spawn` is a node capability/action
for launching agents on nodes (either by name or by letting the workspace select
one with the required capability). Review and align any later sections or card
copy in the document that reference these concepts to use consistent
terminology.

@chatgpt-codex-connector chatgpt-codex-connector Bot 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: eb1fdcb147

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

On the machine (the Mac mini), install the harness CLIs (`claude`, `codex`) on `PATH`, then:

```bash
npm install @agent-relay/fleet @agent-relay/harnesses zod

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Install the CLI before using its fleet commands

In a fresh node setup, this install command does not install the agent-relay binary used by the next steps; that bin is provided by the agent-relay package (packages/cli/package.json), not by @agent-relay/fleet or @agent-relay/harnesses. Users following this page from scratch will hit agent-relay: command not found when they try to run agent-relay fleet serve, so include the CLI install or show an npx/local invocation.

Useful? React with 👍 / 👎.

Serve it — this process *is* the node, so keep it running:

```bash
RELAY_WORKSPACE_KEY=rk_live_... agent-relay fleet serve ./macmini.node.ts

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Export the workspace key for follow-up fleet commands

With this one-command environment assignment, RELAY_WORKSPACE_KEY is visible only to the long-running fleet serve process. The verification command below (agent-relay fleet nodes) is SDK-backed and needs its own workspace key via env/--workspace-key unless the user already has an active workspace configured, so a fresh second shell will fail instead of confirming registration; show export RELAY_WORKSPACE_KEY=... or pass the key to fleet nodes.

Useful? React with 👍 / 👎.

@github-actions

Copy link
Copy Markdown
Contributor

Preview deployed!

Environment URL
Web https://d3ko8uz702ipqx.cloudfront.net

This preview will be cleaned up when the PR is merged or closed.

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