Skip to content

[cli-consistency] Campaign command documentation misplaced under compile section #6961

@github-actions

Description

@github-actions

Issue Description

Type: Documentation clarity issue
Priority: Low

Current State

The documentation for the campaign command section appears within the compile command section, which may confuse users who are looking for information about campaign management.

Evidence from Documentation

From docs/src/content/docs/setup/cli.md:

Lines 271-294: The "Campaign specs and orchestrators" section and the campaign command documentation appear as subsections under the compile command section (which starts at line 240).

Lines 276-294: The campaign command is documented with all its subcommands and examples, but it's embedded within compile command documentation.

Issue

The campaign command is actually a standalone top-level command (confirmed in main.go line 514), not a subcommand of compile. The current documentation structure incorrectly suggests it's related to or part of the compile command.

From the command group tests, campaign should be in the "Analysis Commands" group, not nested under the "Development Commands" (where compile lives).

Actual Impact

Users may:

  1. Miss the campaign command when looking for analysis tools
  2. Think campaign is somehow a subcommand or feature of compile
  3. Not find campaign documentation when searching for "Analysis Commands"

Expected Behavior

The campaign command should have its own standalone section under the "Analysis Commands" heading in the documentation, similar to how logs and audit commands are documented.

Suggested Fix

  1. Move the campaign documentation (lines 276-294) from the compile section
  2. Create a new section in the "Monitoring" or "Analysis" section
  3. Keep only the campaign-spec-related compilation behavior documentation in the compile section (lines 271-274)
  4. Add a cross-reference in the compile section pointing to the full campaign command documentation

Example structure:

### Building

#### `compile`
[...existing content...]

Campaign specs and orchestrators: When campaign specs exist, compile validates them. See the [`campaign` command](#campaign) for management.

[...]

### Analysis (or Monitoring)

#### `campaign`
Inspect and validate first-class campaign definitions...
[full campaign documentation here]

AI generated by CLI Consistency Checker

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions