Add "Most Common Commands" section to CLI documentation#4492
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
@copilot replace logs with run in most command commands |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Updated in commit 9702017. The Most Common Commands section now features 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:
If you need me to access, download, or install something from one of these locations, you can either:
|
There was a problem hiding this comment.
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 | [](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 | [](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 | [](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 | [](https://github.com/githubnext/gh-aw/actions/workflows/test-close-discussion.lock.yml) | - | - | |
There was a problem hiding this comment.
[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.
| | [Test Close Discussion](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/test-close-discussion.md) | copilot | [](https://github.com/githubnext/gh-aw/actions/workflows/test-close-discussion.lock.yml) | - | - | |

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
docs/src/content/docs/setup/cli.mdinit,add,status,compile,run(per user feedback: removedlist, addedinit, replacedlogswithrun)Result
The section provides immediate orientation for new users without duplicating existing content—just surfacing it effectively.
Original prompt
<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
Suggested Content
Files to Modify
docs/src/content/docs/setup/cli.mdxAcceptance Criteria
Estimated Impact
Related to 📚 Documentation Noob Test Report - November 21, 2025 #4466
Comments on the Issue (you are @copilot in this section)
@pelikhan @copilot ignore list command @pelikhan @copilot add init commandOriginal prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.