Skip to content

Align CLI help/docs consistency for outcomes, project setup, URLs, and wording#33130

Merged
pelikhan merged 2 commits into
mainfrom
copilot/cli-consistency-fixes
May 18, 2026
Merged

Align CLI help/docs consistency for outcomes, project setup, URLs, and wording#33130
pelikhan merged 2 commits into
mainfrom
copilot/cli-consistency-fixes

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 18, 2026

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)

    • Added missing gh aw outcomes command documentation with examples and options.
    • Added missing --with-project-setup coverage under gh aw project new (example + option).
  • Project auth URL consistency (pkg/cli/project_command.go)

    • Updated help text docs link host from github.github.io to github.github.com to match configured site host.
  • Forecast help text cleanup (pkg/cli/forecast_command.go)

    • Removed duplicate double spaces in the long description to normalize rendered help output.
  • MCP server wording consistency (pkg/cli/mcp_server_command.go)

    • Updated --port example 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 in mcp-server port example.
# Newly documented command surface in CLI docs
gh aw outcomes 1234567890 --outcomes-dir ./otlp
gh aw project new "Project Q1" --owner myorg --with-project-setup

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
Copilot AI requested a review from pelikhan May 18, 2026 19:16
@pelikhan pelikhan marked this pull request as ready for review May 18, 2026 19:17
Copilot AI review requested due to automatic review settings May 18, 2026 19:17
@pelikhan pelikhan merged commit 119a141 into main May 18, 2026
@pelikhan pelikhan deleted the copilot/cli-consistency-fixes branch May 18, 2026 19:17
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 outcomes and project 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

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.

[cli-consistency] CLI Consistency Issues - 2026-05-18

3 participants