Skip to content

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

@github-actions

Description

@github-actions

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

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions