-
Notifications
You must be signed in to change notification settings - Fork 43
Open
Labels
automationcode-qualitycookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!documentationImprovements or additions to documentationImprovements or additions to documentationtask-mining
Description
Description
The Quick Start guide lists prerequisites without showing users how to verify they meet them, forcing navigation away from the page and adding friction to the getting-started experience. The Documentation Noob Test and User Experience Analysis both identified this as a critical usability issue.
Current State
- File:
docs/src/content/docs/setup/quick-start.md - Lines: 17-24 (Prerequisites section)
- Issue: Prerequisites lack inline verification commands
- Impact: Users must leave the page to check if they meet requirements
Suggested Changes
Add verification commands inline with each prerequisite:
## Prerequisites
Before installing, ensure you have:
- ✅ **AI Account** - A [GitHub Copilot](https://github.com/features/copilot) subscription, or a [Anthropic Claude]((www.anthropic.com/redacted) or [OpenAI Codex]((openai.com/redacted) API key
``````bash
# Verify Copilot access:
gh copilot explain "test"
# Or verify Claude/Codex API key is set:
echo $ANTHROPIC_API_KEY # or $OPENAI_API_KEY-
✅ GitHub Repository - a GitHub repository you are maintainer on
# List your repositories with admin access: gh repo list --json name,owner,permissions | jq -r '.[] | select(.permissions=="ADMIN") | "\\(.owner.login)/\\(.name)"'
-
✅ GitHub Actions enabled in your repository
# Check if Actions are enabled (returns workflow files if enabled): gh api repos/:owner/:repo/actions/workflows | jq '.total_count'
-
✅ GitHub CLI (
gh) - A command-line tool for GitHub. Install here v2.0.0+# Verify version: gh --version -
✅ Operating System: Linux, macOS, or Windows with WSL
# Check your OS: uname -s
## Files Affected
- `docs/src/content/docs/setup/quick-start.md` (lines 17-24)
## Success Criteria
- [x] All prerequisites include verification commands
- [x] Commands work across Linux, macOS, and WSL
- [x] Commands are copy-pasteable
- [x] Commands provide clear success/failure output
- [x] No navigation away from page required
- [x] Markdown formatting preserved (using 6 backticks)
## Benefits
- **Faster onboarding**: Users verify all prerequisites in-place without external navigation
- **Reduced setup time**: Eliminates back-and-forth with documentation
- **Higher completion rate**: Fewer users abandon setup due to uncertainty
- **Professional experience**: Shows attention to developer workflow
## Source
Extracted from:
- [User Experience Analysis discussion #12700](https://github.com/githubnext/gh-aw/discussions/12700)
- [Documentation Noob Test discussion #12699](https://github.com/githubnext/gh-aw/discussions/12699)
## Priority
High - Affects every new user at the critical first step
## Estimated Effort
1-2 hours
<!-- gh-aw-tracker-id: discussion-task-miner -->
> AI generated by [Discussion Task Miner - Code Quality Improvement Agent](https://github.com/githubnext/gh-aw/actions/runs/21510445430)
> - [x] expires <!-- gh-aw-expires: 2026-02-13T09:14:23.242Z --> on Feb 13, 2026, 9:14 AM UTC
<!-- gh-aw-agentic-workflow: Discussion Task Miner - Code Quality Improvement Agent, gh-aw-tracker-id: discussion-task-miner, engine: copilot, run: https://github.com/githubnext/gh-aw/actions/runs/21510445430 -->
<!-- gh-aw-workflow-id: discussion-task-miner -->
Metadata
Metadata
Assignees
Labels
automationcode-qualitycookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!documentationImprovements or additions to documentationImprovements or additions to documentationtask-mining