-
Notifications
You must be signed in to change notification settings - Fork 49
Closed as not planned
Closed as not planned
Copy link
Labels
automationcode-qualitycookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!documentationImprovements or additions to documentationImprovements or additions to documentationonboardingtask-mining
Description
Description
The Quick Start documentation lists prerequisites without showing users how to verify they meet requirements, forcing them to leave the page and adding friction to the getting-started experience.
Problem
File: docs/src/content/docs/setup/quick-start.md (lines 17-24)
Prerequisites section lists requirements but doesn't show:
- How to verify prerequisites are met
- What success looks like
- Quick verification commands
New users must navigate away to check requirements, wasting time and potentially missing critical setup steps.
Suggested Changes
Add verification commands inline with each prerequisite:
Before (Lines 17-24)
## Prerequisites
Before installing, ensure you have:
- ✅ **AI Account** - A [GitHub Copilot](https://github.com/features/copilot) subscription, or API key
- ✅ **GitHub Repository** - a GitHub repository you are maintainer on
- ✅ **GitHub Actions** enabled in your repository
- ✅ **GitHub CLI** (`gh`) - v2.0.0+
- ✅ **Operating System**: Linux, macOS, or Windows with WSLAfter
## Prerequisites
Before installing, ensure you have:
- ✅ **AI Account** - A [GitHub Copilot](https://github.com/features/copilot) subscription, or API key
```bash
# Verify Copilot access:
gh copilot explain "test"
# Or verify 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: gh api repos/:owner/:repo | jq '.has_issues, .has_projects'
-
✅ GitHub CLI (
gh) - 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 return clear success/failure indicators
- [x] Documentation flows naturally without breaking context
## Benefits
- **User Impact**: Verify all prerequisites in-place without navigation, reducing setup time by 50%+
- **Quality Factor**: Enhances efficiency and productivity
- **Frequency**: Every new user encounters this page - it's the primary entry point
## Source
Extracted from [User Experience Analysis - 2026-01-30](https://github.com/githubnext/gh-aw/discussions/12700)
## Priority
**Medium** - Improves onboarding experience for all new users
## Estimated Effort
Small (2-3 hours) - Single file, straightforward additions
<!-- 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/21517229374)
> - [x] expires <!-- gh-aw-expires: 2026-02-13T13:26:40.812Z --> on Feb 13, 2026, 1:26 PM 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/21517229374 -->
<!-- gh-aw-workflow-id: discussion-task-miner -->
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
automationcode-qualitycookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!documentationImprovements or additions to documentationImprovements or additions to documentationonboardingtask-mining