-
Notifications
You must be signed in to change notification settings - Fork 228
Description
Description
The Quick Start guide mentions customizing workflows but doesn't show what configuration options are available. This requires users to navigate away from the quick start to find configuration examples, reducing efficiency during their first customization attempt.
Current State
Lines 70-74 of docs/src/content/docs/setup/quick-start.md mention editing the workflow file and running gh aw compile, but don't show what a workflow configuration looks like.
Issue
Users who want to customize their workflow must leave the quick start guide to understand what they can configure, which:
- Reduces efficiency for new users during first customization
- Adds unnecessary context switching
- Makes the getting-started experience less smooth
Proposed Solution
Add an inline YAML example showing basic customization options after the current line 74:
After (Enhanced version):
The report is fully customizable. Edit the workflow markdown file at `.github/workflows/daily-repo-status.md` in your repository. The frontmatter section at the top controls key settings:
```yaml
---
description: Daily repository status report
on: daily # Change schedule: hourly, weekly, etc.
engine: copilot # AI engine: copilot, claude, codex
permissions:
contents: read
issues: write
safe-outputs:
create-issue:
labels: [automation, status] # Customize issue labels
---
```
After editing, recompile the workflow:
```bash
gh aw compile
```
This regenerates `.github/workflows/daily-repo-status.lock.yml`. Push to your repository, then trigger a run:
```bash
gh aw run daily-repo-status
```
or use the GitHub Actions UI.Files Affected
docs/src/content/docs/setup/quick-start.md(single file, lines ~70-82)
Success Criteria
- Inline YAML example added to quick start guide
- Example shows common customization options (schedule, engine, labels)
- Example includes helpful inline comments
- No changes to other documentation files required
- Users can understand basic workflow configuration without navigating away
- Quality improves from ✅ Professional to ✅ Professional+ (enhanced usability)
Impact
- Severity: Medium-High - Affects all new users
- Effort: Low - Single file edit, estimated 15-30 minutes
- Risk: Minimal - Documentation-only change
- Benefit: Reduced friction for new users, improved getting-started experience
- Frequency: Every new user attempting their first workflow customization
Source
Extracted from User Experience Analysis Report - 2026-01-28
Priority
High - User-facing improvement with direct impact on onboarding experience
AI generated by Discussion Task Miner - Code Quality Improvement Agent
- expires on Feb 11, 2026, 9:11 AM UTC