Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 26, 2025

The documentation for gh aw add was inconsistent with the CLI's actual description, mentioning only "The Agentics collection" without clarifying it works with any repository or specifying the destination directory.

Changes

Updated docs/src/content/docs/setup/cli.md in two locations:

  • Line 21 (Quick Reference Table): Added "or other repositories" to clarify scope
  • Line 211 (Detailed Description): Added "to .github/workflows" to specify destination

Both now align with pkg/cli/add_command.go line 23:

Short: "Add agentic workflows from repositories to .github/workflows"

The documentation retains the helpful hint about The Agentics collection while accurately describing the command's full capability.

Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] Inconsistent wording for "add" command description</issue_title>
<issue_description>## Issue Description

Command: gh aw add
Type: Inconsistent wording between documentation and CLI
Priority: Low

Documentation States (cli.md line 210)

Add workflows from The Agentics collection or other repositories

CLI Source Code States (add_command.go line 23)

Add agentic workflows from repositories to .github/workflows

Issue

The documentation mentions "The Agentics collection" specifically, while the CLI is more general about repositories. The CLI description also explicitly states the destination (.github/workflows) which is more informative.

Analysis

The documentation's mention of "The Agentics collection" might be helpful context for users, but it's also limiting - the command works with ANY repository, not just that specific collection. The CLI's description is more accurate and complete.

Suggested Fix

Update the documentation at docs/src/content/docs/setup/cli.md line 210 to be more accurate:

Add agentic workflows from repositories to .github/workflows. Displays the workflow description (from frontmatter `description` field) to provide context.

Or keep the helpful hint but make it more general:

Add workflows from The Agentics collection or other repositories to .github/workflows.

The second option keeps the user-friendly hint about the Agentics collection while being more complete.

AI generated by CLI Consistency Checker

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


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits December 26, 2025 14:58
- Update quick reference table to include "or other repositories"
- Update detailed description to include ".github/workflows" destination
- Align documentation with CLI source code (add_command.go line 23)
- Keep helpful hint about The Agentics collection while being accurate

Co-authored-by: mnkiefer <[email protected]>
Copilot AI changed the title [WIP] Fix inconsistent wording for add command description Align add command documentation with CLI source code Dec 26, 2025
Copilot AI requested a review from mnkiefer December 26, 2025 15:04
@pelikhan pelikhan marked this pull request as ready for review December 26, 2025 16:04
@pelikhan pelikhan merged commit b4f252d into main Dec 26, 2025
4 checks passed
@pelikhan pelikhan deleted the copilot/fix-add-command-description branch December 26, 2025 16:04
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] Inconsistent wording for "add" command description

3 participants