-
Notifications
You must be signed in to change notification settings - Fork 43
Open
Labels
Description
Context
As identified in discussion #12027, the engines documentation lacks a complete quick-start example for Claude users. While Claude setup instructions exist, there's no end-to-end "hello world" workflow to demonstrate the complete experience.
Problem
- Claude users need to piece together information from multiple sections
- No single example showing: frontmatter + workflow code + authentication setup
- Missing a "success path" that users can copy-paste and run immediately
- Documentation shows detailed explanations but lacks practical quick-start
Objective
Add a complete, minimal Claude workflow example that users can copy-paste and run successfully within minutes.
Proposed Solution
Add after the Claude Setup section in docs/src/content/docs/reference/engines.md:
### Quick Example: Issue Triage with Claude
Here's a complete example to get started with Claude:
**1. Create `.github/workflows/issue-triage.md`:**
```markdown
---
engine: claude
on: issues
permissions:
contents: read
issues: write
safe-outputs:
add-comment:
---
# Issue Triage
Analyze this issue and provide helpful triage suggestions:
1. Identify the issue type (bug, feature request, question, etc.)
2. Check if the issue has enough information
3. Suggest appropriate labels
4. Provide a helpful response
```
**2. Set up your Anthropic API key:**
```bash
gh aw secrets set ANTHROPIC_API_KEY --value "sk-ant-..."
```
**3. Compile and push the workflow:**
```bash
gh aw compile .github/workflows/issue-triage.md
git add .github/workflows/issue-triage.lock.yml
git commit -m "Add Claude-powered issue triage workflow"
git push
```
**4. Test it:** Open a new issue in your repository - Claude will automatically analyze and comment!Files to Modify
docs/src/content/docs/reference/engines.md(add after Claude Setup section, around line 77)
Acceptance Criteria
- Add complete quick-start example with all steps
- Include frontmatter configuration
- Include workflow markdown content
- Include authentication setup command
- Include compilation and deployment steps
- Include testing instructions
- Verify example is copy-pasteable and works as-is
- Example should be runnable within 5 minutes
Testing
Verify the example works:
- Follow the steps exactly as written
- Ensure the workflow compiles without errors
- Ensure the workflow triggers on a test issue
- Ensure Claude processes and responds successfully
References
- Discussion 🔍 Claude Code User Documentation Review - January 27, 2026 #12027 - Priority 2 recommendation
AI generated by Plan Command for discussion #12027
Copilot