docs(site): align CLI command descriptions with actual help output#797
Merged
jamesadevine merged 1 commit intoMay 31, 2026
Merged
Conversation
- 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>
Open
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.
Summary
Aligned all CLI command descriptions in
cli.mdxwith actual--helpoutput 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--yesrequirement (more than one match)run: Added aggregate result note for--waitexit code behaviorrun: Clarified--poll-intervaland--timeoutunits (seconds)mcp/mcp-http: Explained<bounding_directory>security purposemcp/mcp-http: Clarified--enabled-toolsbehavior (all tools exposed when omitted)--dry-runverb: Changed "print" → "preview" for consistencyAccuracy checks
ado-aw <command> --helpoutput (built from current main)Validation
cd site && npm ci && npm run buildCreated by the docs-writer workflow.