🔍 Claude Code User Documentation Review - February 2, 2026 #13283
Closed
Replies: 1 comment
-
|
This discussion was automatically closed because it expired on 2026-02-09T13:58:31.352Z.
|
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Executive Summary
As a Claude Code user reviewing the gh-aw documentation, I found that Claude users CAN successfully adopt gh-aw, but the documentation has a strong Copilot-first bias that creates unnecessary friction during onboarding. The technology is engine-agnostic and works well with Claude, but the presentation assumes Copilot as the default path.
Key Finding: Claude is well-supported technically (29 example workflows, clear API key setup, full tool compatibility), but the documentation needs better balance to serve non-Copilot users effectively.
Persona Context
I reviewed this documentation as a developer who:
Question 1: Onboarding Experience
Can a Claude Code user understand and get started with gh-aw?
Answer: Yes, but with friction. A motivated Claude user can get started, but they must navigate through Copilot-centric documentation to find their path.
Specific Issues Found:
Quick Start Prerequisites (docs/src/content/docs/setup/quick-start.md:18-21)
Main README Example (README.md:40-62)
gh awcli converts this into a GitHub Actions Workflow (.yml) that runs an AI agent (Copilot, Claude, Codex, ...)"How They Work Page (docs/src/content/docs/introduction/how-they-work.mdx:26)
Quick Start Interactive Mode (docs/src/content/docs/setup/quick-start.md:38-43)
Recommended Fixes:
Reorder Prerequisites to be neutral:
Add Engine-Neutral Language in How They Work:
Create a "Choosing Your Engine" Section in Quick Start that appears BEFORE Step 1, explaining:
Question 2: Inaccessible Features for Non-Copilot Users
What features or steps don't work without Copilot?
Answer: Nearly everything works with Claude! This is excellent news. The system is genuinely engine-agnostic.
Features That Require Copilot:
Features That Work Without Copilot:
Engine-Specific Differences Found:
web-searchsupport" (requires third-party MCP)Missing Documentation:
No Engine Comparison Table showing:
No "Engine Migration Guide" for users switching between engines
No explanation of
COPILOT_MODELenvironment variable for Claude users (does it apply? Is there a Claude equivalent?)Question 3: Documentation Gaps and Assumptions
Where does the documentation assume Copilot usage?
Copilot-Centric Language Found In:
File: README.md:40
File: docs/src/content/docs/introduction/how-they-work.mdx:26
File: docs/src/content/docs/reference/engines.md:10-12
File: docs/src/content/docs/introduction/architecture.mdx:168
File: docs/src/content/docs/setup/cli.md:163
gh aw initsays "Copilot instructions, prompt files" specificallyFile: docs/src/content/docs/reference/faq.md:125
Missing Alternative Instructions:
No "Claude User Quick Start" - A parallel quick start guide specifically for Claude users would eliminate confusion
No Engine Selection Guide - "Which engine should I choose?" section with trade-offs:
No Claude-Specific Examples in CLI docs - All examples use Copilot workflows
No "Migrating from Copilot to Claude" guide for users who want to switch
Severity-Categorized Findings
🚫 Critical Blockers (Score: 0/10)
Good news: No critical blockers found! Claude users can successfully install, configure, and use gh-aw.
Obstacle 1: Copilot-First Quick Start Guide
Impact: Significant friction in getting started - Claude users must mentally translate "default" language
Current State:
Why It's Problematic:
Suggested Fix:
gh aw initinteractive mode helps select engineAffected Files:
docs/src/content/docs/setup/quick-start.mdObstacle 2: "Default" Framing Throughout Documentation
Impact: Significant psychological barrier - Claude users question if they're using a "lesser" option
Current State:
Why It's Problematic:
gh aw initSuggested Fix:
Affected Files:
docs/src/content/docs/introduction/how-they-work.mdxdocs/src/content/docs/reference/engines.mddocs/src/content/docs/introduction/architecture.mdxdocs/src/content/docs/reference/faq.mdREADME.mdObstacle 3: No Engine Comparison Documentation
Impact: Claude users can't make informed decisions about whether to use Claude vs alternatives
Current State:
Why It's Problematic:
Suggested Fix:
Create a new "Engine Comparison" page with:
Total workflows analyzed: 112
Quality of Examples
Copilot Examples:
Claude Examples:
Assessment:
Recommended Actions
Priority 1: Critical Documentation Fixes
Remove "Default" Language - Impact: High | Effort: Low
how-they-work.mdx,engines.md,faq.md,README.mdReorder Quick Start Prerequisites - Impact: High | Effort: Low
docs/src/content/docs/setup/quick-start.md:18-21Add "Choose Your Engine" Section - Impact: High | Effort: Medium
docs/src/content/docs/setup/quick-start.mdPriority 2: Major Improvements
Create Engine Comparison Page - Impact: High | Effort: High
docs/src/content/docs/reference/engine-comparison.mdUpdate Architecture Diagrams - Impact: Medium | Effort: Medium
docs/src/content/docs/introduction/architecture.mdxAdd More Claude Examples - Impact: Medium | Effort: High
.github/workflows/*.mdPriority 3: Nice-to-Have Enhancements
Positive Findings
What Works Well
Conclusion
Can Claude Code Users Successfully Adopt gh-aw?
Answer: Yes, with moderate effort to navigate Copilot-first documentation.
Reasoning:
The gh-aw system is architecturally sound and genuinely engine-agnostic. Claude is well-supported technically with 29 example workflows, clear API key setup, and full tool compatibility. The code works excellently with Claude.
However, the documentation presentation creates unnecessary friction through:
A Claude user who persists through this friction will successfully set up and use gh-aw. The technical barriers are minimal. But the psychological barrier of feeling like a "non-default" user discourages adoption.
The fix is straightforward: Neutral language, engine comparison docs, and balanced presentation would make gh-aw equally welcoming to all engine users.
Overall Assessment Score: 7.5/10
Breakdown:
Clarity for non-Copilot users: 7/10
Claude engine documentation: 8/10
Alternative approaches provided: 7/10
Engine parity: 8/10
Overall: 7.5/10 - Good technical foundation with room for improved presentation
Next Steps
Immediate Actions (This Week):
Short-Term Actions (This Month):
Long-Term Actions (This Quarter):
Appendix: Files Reviewed
Complete List of Documentation Files Analyzed
Core Documentation:
README.md- Main project READMEdocs/src/content/docs/setup/quick-start.md- Quick Start Guidedocs/src/content/docs/introduction/how-they-work.mdx- How They Workdocs/src/content/docs/introduction/architecture.mdx- Security Architecturedocs/src/content/docs/reference/tools.md- Tools Referencedocs/src/content/docs/setup/cli.md- CLI Referencedocs/src/content/docs/reference/engines.md- AI Engines Documentationdocs/src/content/docs/reference/faq.md- Frequently Asked QuestionsExample Workflows Analyzed:
.github/workflows/*.md- 112 workflow files analyzed for engine usage.github/workflows/audit-workflows.md- Claude example.github/workflows/blog-auditor.md- Claude example.github/workflows/claude-code-user-docs-review.md- Claude example (this workflow)Additional Context:
docs/src/content/docs/guides/- Various guide documentationReport Generated: 2026-02-02
Workflow Run: 21592750303
Engine Used: claude (eating our own dog food! 🐕)
Beta Was this translation helpful? Give feedback.
All reactions