Skip to content

docs(site): align CLI command descriptions with actual help output#797

Merged
jamesadevine merged 1 commit into
mainfrom
docs/fix-disable-paused-description-03113384f79d0a4d
May 31, 2026
Merged

docs(site): align CLI command descriptions with actual help output#797
jamesadevine merged 1 commit into
mainfrom
docs/fix-disable-paused-description-03113384f79d0a4d

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Summary

Aligned all CLI command descriptions in cli.mdx with actual --help output from ado-aw 0.30.2. Improved clarity and accuracy for users consulting the reference docs.

Changes

  • disable: Clarified disabled vs paused behavior (disabled rejects all queue requests; paused queues scheduled runs but holds them without executing)
  • remove: Clarified --yes requirement (more than one match)
  • run: Added aggregate result note for --wait exit code behavior
  • run: Clarified --poll-interval and --timeout units (seconds)
  • mcp/mcp-http: Explained <bounding_directory> security purpose
  • mcp/mcp-http: Clarified --enabled-tools behavior (all tools exposed when omitted)
  • Standardized --dry-run verb: Changed "print" → "preview" for consistency

Accuracy checks

  • Verified every command description against ado-aw <command> --help output (built from current main)
  • No invented flags, options, or behaviors — all changes match source-of-truth CLI help text
  • Focused on clarity improvements where docs diverged from actual CLI behavior (e.g., "hold the queue" → "queue scheduled runs but hold them without executing")

Validation

  • cd site && npm ci && npm run build
  • Build succeeded with no errors
  • All internal links validated

Created by the docs-writer workflow.

Generated by Docs Writer · ● 1.8M ·

- disable: clarified disabled vs paused behavior (disabled rejects all queue
  requests; paused queues scheduled runs but holds them without executing)
- remove: clarified --yes requirement (more than one match)
- run: added aggregate result note for --wait exit code behavior
- run: clarified --poll-interval and --timeout units (seconds)
- mcp/mcp-http: explained bounding_directory security purpose
- mcp/mcp-http: clarified --enabled-tools behavior (all tools exposed when omitted)
- Standardized "preview" verb for --dry-run (was "print")

All changes verified against actual CLI help output from ado-aw 0.30.2.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot mentioned this pull request May 30, 2026
@jamesadevine jamesadevine marked this pull request as ready for review May 31, 2026 17:05
@jamesadevine jamesadevine merged commit d661280 into main May 31, 2026
@jamesadevine jamesadevine deleted the docs/fix-disable-paused-description-03113384f79d0a4d branch May 31, 2026 17:09
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