Skip to content

Comments

Move campaign command documentation to dedicated Campaigns section#6964

Merged
pelikhan merged 7 commits intomainfrom
copilot/fix-campaign-command-documentation
Dec 19, 2025
Merged

Move campaign command documentation to dedicated Campaigns section#6964
pelikhan merged 7 commits intomainfrom
copilot/fix-campaign-command-documentation

Conversation

Copy link
Contributor

Copilot AI commented Dec 19, 2025

Documentation Reorganization Complete ✓

  • Understand the issue: campaign command is misplaced under compile section
  • Verify campaign command group assignment (analysis group in main.go:543)
  • Locate current documentation placement (lines 270-294 under Building section)
  • Identify correct section (Monitoring section, lines 360-403)
  • Move campaign command documentation from Building to Monitoring section
  • Update campaign specs reference in compile section to be a brief note with cross-reference
  • Move campaign to its own dedicated section per feedback
  • Merge main branch and recompile workflows
  • Verify documentation structure matches command groups

Changes Summary

Final Structure

### Monitoring
  ├── status
  ├── logs
  └── audit

### Campaigns  ← New dedicated section
  └── campaign

### Management
  ├── enable
  ├── disable
  └── ...

What Changed

  1. Created new "Campaigns" section (###) for campaign command
  2. Positioned between Monitoring and Management sections
  3. Merged main branch and resolved conflicts
  4. Recompiled all 117 workflows successfully

Previous Changes

  • Moved campaign from Building section
  • Updated compile section with brief campaign specs note + cross-reference
  • Added anchor link for easy navigation

Verification

  • ✓ Command group: "analysis" (main.go:543)
  • ✓ Own dedicated section: "Campaigns"
  • ✓ Positioned logically between Monitoring and Management
  • ✓ Anchor link format: consistent with existing links
  • ✓ Main branch merged
  • ✓ All workflows recompiled
Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] Campaign command documentation misplaced under compile section</issue_title>
<issue_description>## 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

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits December 19, 2025 14:01
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
- Moved campaign command from Building section to Monitoring section
- Updated campaign specs reference in compile section to be concise
- Added cross-reference link from compile to campaign command
- Campaign now appears after audit command in Monitoring section
- Matches command group assignment (analysis group) in main.go

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix misplaced campaign command documentation under compile section Move campaign command documentation to Monitoring section Dec 19, 2025
Copilot AI requested a review from mnkiefer December 19, 2025 14:10
@pelikhan
Copy link
Contributor

@copilot move campaign to own section

- Created new "Campaigns" section (###) for campaign command
- Positioned between Monitoring and Management sections
- Campaign now has dedicated section as requested

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 19, 2025

@copilot move campaign to own section

Done in 6e0e6fe. Campaign command now has its own dedicated "Campaigns" section positioned between Monitoring and Management.

Structure:

### Monitoring
  ├── status
  ├── logs
  └── audit

### Campaigns  ← New section
  └── campaign

### Management
  └── ...

Copilot AI changed the title Move campaign command documentation to Monitoring section Move campaign command documentation to dedicated Campaigns section Dec 19, 2025
Copilot AI requested a review from pelikhan December 19, 2025 14:19
@pelikhan pelikhan marked this pull request as ready for review December 19, 2025 14:22
@pelikhan
Copy link
Contributor

@copilot merge main and recompile

Copilot AI and others added 2 commits December 19, 2025 14:30
…command-documentation

# Conflicts:
#	.github/workflows/ai-moderator.lock.yml
#	.github/workflows/archie.lock.yml
#	.github/workflows/artifacts-summary.lock.yml
#	.github/workflows/audit-workflows.lock.yml
#	.github/workflows/blog-auditor.lock.yml
#	.github/workflows/brave.lock.yml
#	.github/workflows/breaking-change-checker.lock.yml
#	.github/workflows/campaign-generator.lock.yml
#	.github/workflows/changeset.lock.yml
#	.github/workflows/ci-coach.lock.yml
#	.github/workflows/ci-doctor.lock.yml
#	.github/workflows/cli-consistency-checker.lock.yml
#	.github/workflows/cli-version-checker.lock.yml
#	.github/workflows/cloclo.lock.yml
#	.github/workflows/close-old-discussions.lock.yml
#	.github/workflows/commit-changes-analyzer.lock.yml
#	.github/workflows/copilot-agent-analysis.lock.yml
#	.github/workflows/copilot-pr-merged-report.lock.yml
#	.github/workflows/copilot-pr-nlp-analysis.lock.yml
#	.github/workflows/copilot-pr-prompt-analysis.lock.yml
#	.github/workflows/copilot-session-insights.lock.yml
#	.github/workflows/craft.lock.yml
#	.github/workflows/daily-assign-issue-to-user.lock.yml
#	.github/workflows/daily-code-metrics.lock.yml
#	.github/workflows/daily-copilot-token-report.lock.yml
#	.github/workflows/daily-doc-updater.lock.yml
#	.github/workflows/daily-fact.lock.yml
#	.github/workflows/daily-file-diet.lock.yml
#	.github/workflows/daily-firewall-report.lock.yml
#	.github/workflows/daily-issues-report.lock.yml
#	.github/workflows/daily-malicious-code-scan.lock.yml
#	.github/workflows/daily-multi-device-docs-tester.lock.yml
#	.github/workflows/daily-news.lock.yml
#	.github/workflows/daily-performance-summary.lock.yml
#	.github/workflows/daily-repo-chronicle.lock.yml
#	.github/workflows/daily-team-status.lock.yml
#	.github/workflows/daily-workflow-updater.lock.yml
#	.github/workflows/deep-report.lock.yml
#	.github/workflows/dependabot-go-checker.lock.yml
#	.github/workflows/dev-hawk.lock.yml
#	.github/workflows/dev.lock.yml
#	.github/workflows/developer-docs-consolidator.lock.yml
#	.github/workflows/dictation-prompt.lock.yml
#	.github/workflows/docs-noob-tester.lock.yml
#	.github/workflows/duplicate-code-detector.lock.yml
#	.github/workflows/example-permissions-warning.lock.yml
#	.github/workflows/example-workflow-analyzer.lock.yml
#	.github/workflows/firewall-escape.lock.yml
#	.github/workflows/firewall.lock.yml
#	.github/workflows/github-mcp-structural-analysis.lock.yml
#	.github/workflows/github-mcp-tools-report.lock.yml
#	.github/workflows/glossary-maintainer.lock.yml
#	.github/workflows/go-fan.lock.yml
#	.github/workflows/go-file-size-reduction-project64.campaign.g.lock.yml
#	.github/workflows/go-file-size-reduction.campaign.g.lock.yml
#	.github/workflows/go-logger.lock.yml
#	.github/workflows/go-pattern-detector.lock.yml
#	.github/workflows/grumpy-reviewer.lock.yml
#	.github/workflows/hourly-ci-cleaner.lock.yml
#	.github/workflows/human-ai-collaboration.lock.yml
#	.github/workflows/incident-response.lock.yml
#	.github/workflows/instructions-janitor.lock.yml
#	.github/workflows/intelligence.lock.yml
#	.github/workflows/issue-arborist.lock.yml
#	.github/workflows/issue-classifier.lock.yml
#	.github/workflows/issue-monster.lock.yml
#	.github/workflows/issue-triage-agent.lock.yml
#	.github/workflows/jsweep.lock.yml
#	.github/workflows/layout-spec-maintainer.lock.yml
#	.github/workflows/lockfile-stats.lock.yml
#	.github/workflows/mcp-inspector.lock.yml
#	.github/workflows/mergefest.lock.yml
#	.github/workflows/notion-issue-summary.lock.yml
#	.github/workflows/org-health-report.lock.yml
#	.github/workflows/org-wide-rollout.lock.yml
#	.github/workflows/pdf-summary.lock.yml
#	.github/workflows/plan.lock.yml
#	.github/workflows/poem-bot.lock.yml
#	.github/workflows/portfolio-analyst.lock.yml
#	.github/workflows/pr-nitpick-reviewer.lock.yml
#	.github/workflows/prompt-clustering-analysis.lock.yml
#	.github/workflows/python-data-charts.lock.yml
#	.github/workflows/q.lock.yml
#	.github/workflows/release.lock.yml
#	.github/workflows/repo-tree-map.lock.yml
#	.github/workflows/repository-quality-improver.lock.yml
#	.github/workflows/research.lock.yml
#	.github/workflows/safe-output-health.lock.yml
#	.github/workflows/schema-consistency-checker.lock.yml
#	.github/workflows/scout.lock.yml
#	.github/workflows/security-compliance.lock.yml
#	.github/workflows/security-fix-pr.lock.yml
#	.github/workflows/semantic-function-refactor.lock.yml
#	.github/workflows/slide-deck-maintainer.lock.yml
#	.github/workflows/smoke-claude.lock.yml
#	.github/workflows/smoke-codex-firewall.lock.yml
#	.github/workflows/smoke-codex.lock.yml
#	.github/workflows/smoke-copilot-no-firewall.lock.yml
#	.github/workflows/smoke-copilot-playwright.lock.yml
#	.github/workflows/smoke-copilot-safe-inputs.lock.yml
#	.github/workflows/smoke-copilot.lock.yml
#	.github/workflows/smoke-detector.lock.yml
#	.github/workflows/smoke-srt-custom-config.lock.yml
#	.github/workflows/smoke-srt.lock.yml
#	.github/workflows/spec-kit-execute.lock.yml
#	.github/workflows/spec-kit-executor.lock.yml
#	.github/workflows/speckit-dispatcher.lock.yml
#	.github/workflows/stale-repo-identifier.lock.yml
#	.github/workflows/static-analysis-report.lock.yml
#	.github/workflows/sub-issue-closer.lock.yml
#	.github/workflows/super-linter.lock.yml
#	.github/workflows/technical-doc-writer.lock.yml
#	.github/workflows/tidy.lock.yml
#	.github/workflows/typist.lock.yml
#	.github/workflows/unbloat-docs.lock.yml
#	.github/workflows/video-analyzer.lock.yml
#	.github/workflows/weekly-issue-summary.lock.yml
- Merged origin/main into branch
- Resolved merge conflicts in lock files
- Recompiled all 117 workflows successfully

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 19, 2025

@copilot merge main and recompile

Done in 39944ea. Merged origin/main and recompiled all 117 workflows successfully.

Merge details:

  • Resolved conflicts in lock files by accepting our version
  • Rebuilt binary with latest changes
  • Recompiled all workflows
  • All 117 workflows compiled successfully (45.7 MB total)

@pelikhan pelikhan merged commit 186bb54 into main Dec 19, 2025
3 of 4 checks passed
@pelikhan pelikhan deleted the copilot/fix-campaign-command-documentation branch December 19, 2025 14:34
mnkiefer added a commit that referenced this pull request Dec 19, 2025
…6964)

* Initial plan

* Initial plan: Move campaign command documentation to Monitoring section

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>

* Move campaign command documentation to Monitoring section

- Moved campaign command from Building section to Monitoring section
- Updated campaign specs reference in compile section to be concise
- Added cross-reference link from compile to campaign command
- Campaign now appears after audit command in Monitoring section
- Matches command group assignment (analysis group) in main.go

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>

* Move campaign to its own dedicated section

- Created new "Campaigns" section (###) for campaign command
- Positioned between Monitoring and Management sections
- Campaign now has dedicated section as requested

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

* Merge main and recompile workflows

- Merged origin/main into branch
- Resolved merge conflicts in lock files
- Recompiled all 117 workflows successfully

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: Peli de Halleux <pelikhan@users.noreply.github.com>
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] Campaign command documentation misplaced under compile section

3 participants