Skip to content

[cli-consistency] Vague "campaign" command description in documentation #7753

Description

@github-actions

Issue Description

Command: gh aw campaign
Type: Incomplete/vague description in documentation
Priority: Medium

Documentation States (cli.md line 442)

Inspect and validate first-class agentic campaign definitions

CLI Source Code States (campaign/command.go)

Inspect first-class campaign definitions from .github/workflows/*.campaign.md

Issue

The documentation adds "and validate" to the description, but the main campaign command itself doesn't validate - that's a separate campaign validate subcommand. The CLI's description is more accurate by focusing on inspection and explicitly mentioning the file location pattern.

Analysis

Looking at the subcommands:

  • campaign (parent) - Lists/inspects campaigns
  • campaign status - Shows live status
  • campaign new - Creates new spec
  • campaign validate - Validates specs (separate command)

The parent command description should focus on what it does when run without subcommands.

Suggested Fix

Update the documentation at docs/src/content/docs/setup/cli.md line 442 to match the CLI more closely:

Inspect first-class agentic campaign definitions declared in .github/workflows/*.campaign.md

This is more specific about the file location and doesn't imply validation (which is a separate subcommand).

AI generated by CLI Consistency Checker

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions