docs(fleets): correct lifecycle/status to wire truth, de-dup install#109
Merged
Conversation
Audit of fleets docs against the agentsfleet daemon (Zig), CLI, and
openapi.json, scoped to three end-user journeys: install a fleet, learn
about a fleet, run the guided (catalogue-template) fleet.
- overview: rebuild the lifecycle to the real FleetStatus values
(active/paused/stopped/killed); add the server-set `paused` state
(steer refused with UZ-AGT-012, webhook gets 200 {"ignored":"fleet_paused"});
drop the invented "Processing"/"Deleted" statuses. Source:
fleet_runtime/config_types.zig, errors/error_entries.zig.
- running: fix the `status` sample to the real key-value shape (no ID
column, status `active` not `alive`) per cli fleet.ts; document the
`steer` interactive session (prompt, exit 130, stdin pipe) per repl.ts;
replace the duplicated install section + exit-code table with a pointer
to fleets/install (single source).
- templates: note the default API-wake budget ($1.00/day) per
create.zig; link the Quickstart as the guided first run.
- overview: lead "What's next" with the guided Quickstart card.
Verified-correct claims left untouched: install/running exit-code tables
(match EXIT_CODE), UZ-BUNDLE-003 pre-install credential gate
(create.zig:154), UZ-AGT-006, UZ-WH-001.
mintlify validate + broken-links: clean.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- running: intro no longer implies `--from` is the only install source (mentions `--template` too). - running: link `agentsfleet list` to the CLI reference (verified real — cli-tree-fleet.ts:163, documented at cli/agentsfleet.mdx). - running: backtick the `agentsfleet` binary name in the steer note. - overview: backtick item 5 (`delete`) for formatting consistency with items 1–4; intro already notes deleted is not a status value. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
Addressed all four review points in f4506a0:
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adversarial audit of the fleets docs against ground truth — the
agentsfleetdaemon (Zig), the CLI, andpublic/openapi.json— scoped to three end-user journeys: install a fleet, learn about a fleet, run the guided fleet (= installing a catalogue template; there is no separate "built-in/guided" feature in code).Fixes
running.mdxalive→activecli fleet.ts:108prints rawz.status; enum has noaliveoverview.mdxpaused(steer →UZ-AGT-012, webhook →200 {"ignored":"fleet_paused"}); dropped inventedProcessing/Deletedstatusesconfig_types.zig,error_entries.zigrunning.mdxstatusoutput → real key-value shape (no ID column/border)fleet.tsprintSection+printKeyValuerunning.mdxsteerinteractive session (>prompt, exit130, stdin pipe)lib/repl.tstemplates.mdx$1.00/daybudgetcreate.zig:29running.mdxfleets/installoverview.mdx,templates.mdxVerified-correct, left untouched
The adversarial pass also cleared (and thus protected) several claims a scout pass had wrongly flagged:
EXIT_CODEmap exactly (1=auth, 2=net, 3=server, 4=validation, 5=config).UZ-BUNDLE-003pre-install credential gate is real (create.zig:154 ensureBundleCredentials);UZ-AGT-006,UZ-WH-001real.integration-requests/workspaces/{id}/eventsalready present indocs.json.Out of scope (flagged, not dropped)
received/processed/fleet_error/gate_blocked) and approval-gate lifecycle have no user-facing concept page — follow-up candidate.Verification
npx mintlify validate✓ ·npx mintlify broken-links✓ ·gitleaks✓. Net −5 lines.🤖 Generated with Claude Code
Greptile Summary
This PR corrects the fleets documentation against daemon ground truth: status values (
alive→active), thestatuscommand output shape, and the lifecycle diagram — dropping inventedProcessing/Deletedstates and adding the real server-setpausedstate. It also de-duplicates the install section inrunning.mdxwith a pointer to/fleets/install, documents the interactivesteerREPL session, and cross-links the Quickstart from bothoverview.mdxandtemplates.mdx.overview.mdx: Lifecycle rebuilt with real status enum (active,paused,stopped,killed); mermaid diagram updated;pausedstate described with its server-only semantics, error codes (UZ-AGT-012,200 {\"ignored\":\"fleet_paused\"}), and auto-resume behaviour.running.mdx: Status sample corrected to key-value shape; duplicated install block replaced with a cross-reference; interactive steer session (>prompt, Ctrl-C exits 130, stdin pipe) documented.templates.mdx:$1.00/daydefault-API-wake budget cap added for--templateinstalls; Quickstart tip inserted at the top.Confidence Score: 5/5
Safe to merge — all changes are documentation corrections backed by CLI and daemon source evidence; no logic or configuration is affected.
The changes replace invented status names and UI shapes with values verified against the daemon source and CLI. The de-duplication and cross-linking are mechanical and low-risk. The one minor omission (missing budget-cap note in the local-bundle path) is a docs inconsistency only, with no runtime impact.
fleets/templates.mdx — the $1.00/day budget cap note is present for --template installs but absent from the --from local-bundle description.
Important Files Changed
activereplacingalive; interactive steer session documented.Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart LR Install["agentsfleet install\n(--from or --template)"] --> Active["active\nwebhook live"] Active -->|"event: run then exit"| Active Active -->|"rate limit / circuit breaker\n(server-set)"| Paused["paused\nUZ-AGT-012 / 200 fleet_paused"] Paused -->|"auto-resume or\nagentsfleet resume"| Active Active -->|"agentsfleet stop"| Stopped["stopped\nreversible"] Stopped -->|"agentsfleet resume"| Active Active -->|"agentsfleet kill"| Killed["killed\nterminal"] Stopped -->|"agentsfleet kill"| Killed Killed -->|"agentsfleet delete"| Deleted(["deleted\nrow removed"])%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%% flowchart LR Install["agentsfleet install\n(--from or --template)"] --> Active["active\nwebhook live"] Active -->|"event: run then exit"| Active Active -->|"rate limit / circuit breaker\n(server-set)"| Paused["paused\nUZ-AGT-012 / 200 fleet_paused"] Paused -->|"auto-resume or\nagentsfleet resume"| Active Active -->|"agentsfleet stop"| Stopped["stopped\nreversible"] Stopped -->|"agentsfleet resume"| Active Active -->|"agentsfleet kill"| Killed["killed\nterminal"] Stopped -->|"agentsfleet kill"| Killed Killed -->|"agentsfleet delete"| Deleted(["deleted\nrow removed"])Comments Outside Diff (1)
fleets/running.mdx, line 8 (link)--from <path>reference in intro paragraphThe overview sentence still reads
`install --from <path>` brings a fleet up, but the dedicated install section now covers both--fromand--template. A reader scanning this line first gets the impression only--fromexists, which contradicts the section body added a few lines below.Prompt To Fix With AI
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Reviews (2): Last reviewed commit: "docs(fleets): address greptile review on..." | Re-trigger Greptile