-
Notifications
You must be signed in to change notification settings - Fork 46
Closed
Labels
automationcode-qualitycookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requesttask-mining
Description
Description
Claude users need a complete, minimal workflow example to quickly understand how to use Claude with gh-aw. Currently, the documentation focuses on Copilot examples, leaving Claude users to infer how things work.
Affected File
docs/src/content/docs/reference/engines.md
Current Gap
The Claude Setup section explains configuration but lacks a concrete "hello world" example showing:
- Complete workflow file structure
- Required frontmatter
- API key setup command
- What the workflow actually does
Suggested Addition
Add after the "Claude Setup" section:
### Quick Example with Claude
Here's a minimal workflow that uses Claude to analyze GitHub issues:
**File**: `.github/workflows/issue-analyzer.md`
``````yaml
---
engine: claude
on:
issues:
types: [opened]
permissions:
contents: read
issues: write
safe-outputs:
add-comment:
---
# Issue Analysis
Analyze this issue and provide:
1. Summary of the problem
2. Suggested labels
3. Any immediate concernsSetup:
- Get your API key from [Anthropic Console]((redacted)
- Set the secret:
gh aw secrets set ANTHROPIC_API_KEY --value "(your-anthropic-api-key)"
- Compile and run:
gh aw compile issue-analyzer.md git add .github/workflows/issue-analyzer.lock.yml git commit -m "Add issue analyzer workflow" git push
What it does:
- Triggers on new issues
- Claude analyzes the issue content
- Posts a comment with analysis
- Uses same safe-outputs system as all engines
## Impact
**Severity**: Medium
**Audience**: New Claude users
**Benefit**:
- Reduces time-to-first-workflow
- Shows Claude is a first-class option
- Provides copy-paste starting point
## Success Criteria
- [ ] Complete workflow example added to `engines.md`
- [ ] Example includes all required frontmatter
- [ ] Setup steps clearly documented
- [ ] Example is tested and works
- [ ] Documentation builds successfully
## Source
Extracted from [Claude Code User Documentation Review discussion #12027](https://github.com/githubnext/gh-aw/discussions/12027)
**Finding**: Priority 2 - Add "Getting Started with Claude" quick example
**Priority**: Medium
**Effort**: Low
## Notes
- Example should be minimal but complete (not "hello world" but a real use case)
- Should demonstrate Claude-specific strengths (reasoning, analysis)
- Should work without modification if user follows setup steps
- Consider adding similar examples for Codex later
<!-- 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/21413996494)
> - [x] expires <!-- gh-aw-expires: 2026-02-10T21:06:25.795Z --> on Feb 10, 2026, 9:06 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/21413996494 -->
<!-- gh-aw-workflow-id: discussion-task-miner -->
Reactions are currently unavailable
Metadata
Metadata
Labels
automationcode-qualitycookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requesttask-mining