Repository navigation
[plan] Add anchor links from CLI Commands summary table to detailed sections and add 'When to use' examples #43689
Description
Objective
Make each command in the "Most Common Commands" summary table on the CLI page link to its detailed section below, and add short usage examples or a "When to use" column.
Context
Discussion #43686 (Documentation Noob Tester report, issue #5) noted that the CLI page opens with a summary table of commands (e.g., gh aw audit, gh aw logs) but the entries have no inline examples and no links to the detailed sections below. A beginner has no context for when to use each command.
File to Modify
docs/src/content/docs/setup/cli.md
Implementation Plan
Approach
- Open
docs/src/content/docs/setup/cli.mdand locate the "Most Common Commands" table. - For each command row, make the command name a markdown anchor link to the corresponding heading further down the page (e.g.,
[gh aw audit](#gh-aw-audit)). Add anchors to detailed section headings if they are missing. - Add a brief "When to use" column (or a one-line example) to the summary table. Keep it to ≤10 words per cell.
Files to Modify
docs/src/content/docs/setup/cli.md
Acceptance Criteria
- Each command name in the summary table links to its detailed section anchor on the same page
- A short "When to use" note or inline example is present for each row in the summary table
- The page renders correctly (no broken markdown)
Generated by 📋 Plan Command · 27.1 AIC · ⌖ 10.7 AIC · ⊞ 4.9K · ◷
Comment /plan to run again
- expires on Jul 7, 2026, 9:34 PM UTC-08:00
Activity