Skip to content

Add "Most Common Commands" section to CLI documentation#4492

Merged
pelikhan merged 3 commits intomainfrom
copilot/add-most-common-commands-section
Nov 21, 2025
Merged

Add "Most Common Commands" section to CLI documentation#4492
pelikhan merged 3 commits intomainfrom
copilot/add-most-common-commands-section

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Nov 21, 2025

The CLI documentation contains 176 code blocks documenting all commands, making it difficult for beginners to identify essential commands. This adds a prominent section at the top highlighting the 5 commands covering 95% of user needs.

Changes

  • Added "Most Common Commands" section before Quick Start in docs/src/content/docs/setup/cli.md
    • Commands: init, add, status, compile, run (per user feedback: removed list, added init, replaced logs with run)
    • Table format with command, use case, and links to detailed documentation
    • Visual emphasis: 🚀 emoji heading and tip callout box for beginners
    • Pointer to complete reference below

Result

The section provides immediate orientation for new users without duplicating existing content—just surfacing it effectively.

[!WARNING]

Original prompt

This section details on the original issue you should resolve

<filter_complete></filter_complete>

<issue_title>[task] Add "Most Common Commands" section to CLI documentation</issue_title>
<issue_description>## Objective
Add a prominent "Most Common Commands" section at the top of the CLI documentation page to help beginners identify essential commands quickly.

Context

The CLI page has 176 code blocks documenting all commands in detail, causing information overload. Beginners can't identify which commands they actually need to know first. Part of discussion #4466.

Approach

  1. Add a new section at the top of the CLI page (before the full reference)
  2. Highlight 4-5 commands that cover 95% of user needs
  3. Include one-sentence descriptions of when to use each
  4. Add visual emphasis (emoji, callout, or cards)
  5. Link to detailed docs for each command

Suggested Content

## 🚀 Most Common Commands

95% of users only need these commands:

1. **`gh aw add (workflow)`** - Add a new workflow to your repository
2. **`gh aw status`** - Check status of workflow files
3. **`gh aw compile`** - Compile workflows to GitHub Actions YAML
4. **`gh aw logs (workflow)`** - View execution logs for a workflow
5. **`gh aw list`** - See all available workflows

[Full command reference below...]

Files to Modify

  • docs/src/content/docs/setup/cli.mdx

Acceptance Criteria

  • Section appears at top of page before full reference
  • 4-5 most essential commands are listed
  • Each command has brief, clear description
  • Visual hierarchy makes this section stand out
  • Links to detailed documentation for each command
  • Doesn't duplicate existing content, just surfaces it

Estimated Impact

AI generated by Plan Command for discussion #4466</issue_description>

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

@pelikhan @copilot ignore list command @pelikhan @copilot add init command
Original prompt

This section details on the original issue you should resolve

<issue_title>[task] Add "Most Common Commands" section to CLI documentation</issue_title>
<issue_description>## Objective
Add a prominent "Most Common Commands" section at the top of the CLI documentation page to help beginners identify essential commands quickly.

Context

The CLI page has 176 code blocks documenting all commands in detail, causing information overload. Beginners can't identify which commands they actually need to know first. Part of discussion #4466.

Approach

  1. Add a new section at the top of the CLI page (before the full reference)
  2. Highlight 4-5 commands that cover 95% of user needs
  3. Include one-sentence descriptions of when to use each
  4. Add visual emphasis (emoji, callout, or cards)
  5. Link to detailed docs for each command

Suggested Content

## 🚀 Most Common Commands

95% of users only need these commands:

1. **`gh aw add (workflow)`** - Add a new workflow to your repository
2. **`gh aw status`** - Check status of workflow files
3. **`gh aw compile`** - Compile workflows to GitHub Actions YAML
4. **`gh aw logs (workflow)`** - View execution logs for a workflow
5. **`gh aw list`** - See all available workflows

[Full command reference below...]

Files to Modify

  • docs/src/content/docs/setup/cli.mdx

Acceptance Criteria

  • Section appears at top of page before full reference
  • 4-5 most essential commands are listed
  • Each command has brief, clear description
  • Visual hierarchy makes this section stand out
  • Links to detailed documentation for each command
  • Doesn't duplicate existing content, just surfaces it

Estimated Impact

AI generated by Plan Command for discussion #4466</issue_description>

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

@pelikhan @copilot ignore list command @pelikhan @copilot add init command

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

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add Most Common Commands section to CLI documentation Add "Most Common Commands" section to CLI documentation Nov 21, 2025
Copilot AI requested a review from pelikhan November 21, 2025 14:20
@pelikhan
Copy link
Copy Markdown
Collaborator

@copilot replace logs with run in most command commands

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

Copilot AI commented Nov 21, 2025

@copilot replace logs with run in most command commands

Updated in commit 9702017. The Most Common Commands section now features gh aw run (workflow) instead of logs.

Updated section

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: /opt/hostedtoolcache/node/24.11.1/x64/bin/node node /home/REDACTED/.npm/_npx/aa98e6899c6baff3/node_modules/.bin/astro build (dns block)
    • Triggering command: /opt/hostedtoolcache/node/24.11.1/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

@pelikhan pelikhan marked this pull request as ready for review November 21, 2025 14:44
Copilot AI review requested due to automatic review settings November 21, 2025 14:44
@pelikhan pelikhan merged commit 6de04eb into main Nov 21, 2025
77 checks passed
@pelikhan pelikhan deleted the copilot/add-most-common-commands-section branch November 21, 2025 14:44
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

This PR adds a prominent "Most Common Commands" section to the CLI documentation to help new users quickly identify the essential commands they need. The section addresses the information overload issue where 176 code blocks made it difficult for beginners to get started.

Key Changes:

  • Added a new "Most Common Commands" section at the top of the CLI documentation (before Quick Start)
  • Features 5 essential commands (init, add, status, compile, run) in a table format with use cases
  • Includes visual emphasis with 🚀 emoji and a tip callout for beginners
  • Links to detailed documentation for each command

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/src/content/docs/setup/cli.md Adds the "Most Common Commands" section with table listing 5 core commands (init, add, status, compile, run), their use cases, and anchor links to detailed documentation
docs/src/content/docs/labs.mdx Adds "Test Close Discussion" workflow entry to the experimental workflows table (appears to be an auto-generated documentation update unrelated to the main PR purpose)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

| [Technical Doc Writer](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/technical-doc-writer.md) | copilot | [![Technical Doc Writer](https://github.com/githubnext/gh-aw/actions/workflows/technical-doc-writer.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/technical-doc-writer.lock.yml) | - | - |
| [Test Assign Milestone with Allowed List](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/test-assign-milestone-allowed.md) | claude | [![Test Assign Milestone with Allowed List](https://github.com/githubnext/gh-aw/actions/workflows/test-assign-milestone-allowed.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/test-assign-milestone-allowed.lock.yml) | - | - |
| [Test Claude Assign Milestone](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/test-claude-assign-milestone.md) | claude | [![Test Claude Assign Milestone](https://github.com/githubnext/gh-aw/actions/workflows/test-claude-assign-milestone.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/test-claude-assign-milestone.lock.yml) | - | - |
| [Test Close Discussion](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/test-close-discussion.md) | copilot | [![Test Close Discussion](https://github.com/githubnext/gh-aw/actions/workflows/test-close-discussion.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/test-close-discussion.lock.yml) | - | - |
Copy link

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

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

[nitpick] This change adds a new test workflow entry ("Test Close Discussion") to the labs documentation table. However, this appears unrelated to the PR's stated purpose of adding a "Most Common Commands" section to CLI documentation.

If this is an auto-generated documentation update from a separate workflow addition, consider separating it into its own PR or explaining the relationship in the PR description.

Suggested change
| [Test Close Discussion](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/test-close-discussion.md) | copilot | [![Test Close Discussion](https://github.com/githubnext/gh-aw/actions/workflows/test-close-discussion.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/test-close-discussion.lock.yml) | - | - |

Copilot uses AI. Check for mistakes.
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.

[task] Add "Most Common Commands" section to CLI documentation

3 participants