Align CLI help/docs consistency for outcomes, project setup, URLs, and wording#33130
Merged
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix CLI consistency issues in documentation and help text
Align CLI help/docs consistency for outcomes, project setup, URLs, and wording
May 18, 2026
pelikhan
approved these changes
May 18, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Aligns CLI help text, CLI reference docs, and focused regression tests for documented command behavior and wording consistency.
Changes:
- Adds missing CLI reference coverage for
gh aw outcomesandproject new --with-project-setup. - Updates help text URL/wording and removes duplicate spacing artifacts.
- Adds focused tests for docs host, forecast spacing, and MCP SSE wording.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/setup/cli.md |
Documents outcomes and --with-project-setup usage/options. |
pkg/cli/project_command.go |
Updates project auth docs URL host. |
pkg/cli/project_command_test.go |
Adds regression assertions for the project auth docs URL. |
pkg/cli/forecast_command.go |
Normalizes spacing in forecast long help text. |
pkg/cli/forecast_test.go |
Adds assertions guarding against duplicate spacing. |
pkg/cli/mcp_server_command.go |
Clarifies --port example uses SSE transport. |
pkg/cli/mcp_server_command_test.go |
Adds regression coverage for MCP SSE wording. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 6/7 changed files
- Comments generated: 0
This was referenced May 18, 2026
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.
CLI consistency inspection found doc/help drift in four command surfaces: missing reference entries, an auth-doc host mismatch, whitespace artifacts in help text, and transport wording mismatch.
CLI reference completeness (
docs/src/content/docs/setup/cli.md)gh aw outcomescommand documentation with examples and options.--with-project-setupcoverage undergh aw project new(example + option).Project auth URL consistency (
pkg/cli/project_command.go)github.github.iotogithub.github.comto match configured site host.Forecast help text cleanup (
pkg/cli/forecast_command.go)MCP server wording consistency (
pkg/cli/mcp_server_command.go)--portexample text to explicitly state SSE transport, matching command semantics in the long description.Regression coverage (focused help-text assertions)
pkg/cli/project_command_test.go: asserts correct auth URL host.pkg/cli/forecast_test.go: guards against reintroducing duplicate spacing in key long-description phrases.pkg/cli/mcp_server_command_test.go: asserts SSE wording inmcp-serverport example.