Skip to content

docs(cli): fix stale CLI commands + drop removed webhook form#98

Merged
indykish merged 2 commits into
mainfrom
chore/arch-audit-mdx-corrections
Jun 17, 2026
Merged

docs(cli): fix stale CLI commands + drop removed webhook form#98
indykish merged 2 commits into
mainfrom
chore/arch-audit-mdx-corrections

Conversation

@indykish

@indykish indykish commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Companion to agentsfleet#421 (architecture-docs correctness audit). Aligns the docs-site CLI reference + config with the shipped command surface (cli-tree.ts):

  • configuration.mdxAGENTSFLEET_API_KEY minted via agentsfleet agent-key add (was agent add).
  • agentsfleet.mdxtenant provider set/resetadd/delete; external-agent key commands agent add/list/deleteagent-key add/list/delete.
  • webhooks.mdx — removed the "URL-embedded secret" section (the variant was deleted from the router; HMAC / Svix / per-source path only).

gitleaks clean.

🤖 Generated with Claude Code

Greptile Summary

This PR corrects three stale documentation pages to match the shipped CLI command surface, with no logic or behavior changes. The previous comment about the overview table being out of sync with the renamed agent-key commands has been addressed in this diff.

  • cli/agentsfleet.mdx: Overview table and all section content updated from agent add/list/deleteagent-key add/list/delete, and tenant provider set/resettenant provider add/delete.
  • cli/configuration.mdx: AGENTSFLEET_API_KEY description corrected to reference agentsfleet agent-key add.
  • agents/webhooks.mdx: "Advanced: URL-embedded secret" section removed; a closing sentence now explicitly states the platform accepts only HMAC/Svix signatures or per-source paths.

Confidence Score: 5/5

Docs-only correctness fix with no behavior changes; all renamed commands are updated consistently across all three files.

Every occurrence of the old command names has been updated, the previously flagged stale overview table entry is now correct, and the removed webhook section has no remaining stale cross-references.

No files require special attention.

Important Files Changed

Filename Overview
cli/agentsfleet.mdx Renamed agent add/list/deleteagent-key add/list/delete in both the overview table and all section content; renamed tenant provider settenant provider add and tenant provider resettenant provider delete. All occurrences are consistent throughout the file.
cli/configuration.mdx Single-line update: corrected AGENTSFLEET_API_KEY description to reference agentsfleet agent-key add instead of the removed agentsfleet agent add.
agents/webhooks.mdx Removed the "Advanced: URL-embedded secret" section and appended a one-sentence notice that only HMAC/Svix signatures and per-source paths are accepted; no stale references remain.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[External System POST] --> B{Auth check}
    B -->|HMAC signature valid| C[202 Accepted]
    B -->|Svix signature valid| C
    B -->|Per-source path\n/github /approval\n/grant-approval /svix| C
    B -->|No valid auth| D[401 Rejected]
    C --> E[Event enqueued → agent woken]
Loading
%%{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 TD
    A[External System POST] --> B{Auth check}
    B -->|HMAC signature valid| C[202 Accepted]
    B -->|Svix signature valid| C
    B -->|Per-source path\n/github /approval\n/grant-approval /svix| C
    B -->|No valid auth| D[401 Rejected]
    C --> E[Event enqueued → agent woken]
Loading

Comments Outside Diff (1)

  1. cli/agentsfleet.mdx, line 14 (link)

    P1 The overview table at the top of the file still shows the old agent add, agent list, agent delete commands. The section content below was correctly updated to agent-key add/list/delete, but the table was missed, leaving a stale entry that will mislead users who scan the summary before reading the full reference.

    Prompt To Fix With AI
    This is a comment left during a code review.
    Path: cli/agentsfleet.mdx
    Line: 14
    
    Comment:
    The overview table at the top of the file still shows the old `agent add`, `agent list`, `agent delete` commands. The section content below was correctly updated to `agent-key add/list/delete`, but the table was missed, leaving a stale entry that will mislead users who scan the summary before reading the full reference.
    
    
    
    How can I resolve this? If you propose a fix, please make it concise.

    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(cli): sync overview table to agent-..." | Re-trigger Greptile

Aligns the CLI reference + config docs with the shipped command surface (cli-tree.ts): configuration.mdx AGENTSFLEET_API_KEY minted via 'agentsfleet agent-key add' (not 'agent add'); agentsfleet.mdx 'tenant provider set/reset' -> 'add/delete' and external-agent commands 'agent add/list/delete' -> 'agent-key add/list/delete'; webhooks.mdx drops the URL-embedded-secret section (variant removed from the router — HMAC/Svix/per-source path only). Companion to agentsfleet#421.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jun 17, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
megam 🟢 Ready View Preview Jun 17, 2026, 3:29 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

The Overview table still listed the removed `agent add`/`agent list`/
`agent delete` commands while the External agents section below was
already updated to `agent-key add/list/delete`. Align the table so the
summary scan matches the full reference.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@indykish

Copy link
Copy Markdown
Contributor Author

Fixed in b188e38: the Overview table at cli/agentsfleet.mdx:14 was still listing the removed agent add / agent list / agent delete commands. Synced it to agent-key add / agent-key list / agent-key delete so the summary scan matches the External agents section below (lines 297-320). Thanks for the catch.

@indykish indykish merged commit e472254 into main Jun 17, 2026
4 checks passed
@indykish indykish deleted the chore/arch-audit-mdx-corrections branch June 17, 2026 17:58
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