Objective
Create comprehensive documentation for error handling patterns, common error scenarios, recovery strategies, and debugging techniques specific to gh-aw.
Context
Despite 51 references to error handling guides in the codebase, only 1 error message documentation exists. Developers need a comprehensive guide covering error patterns, recovery strategies, and debugging runbooks.
Files to Create/Modify
- Create:
specs/error-recovery-patterns.md
- Update:
AGENTS.md (add link to new doc in Available Skills Reference)
Documentation Structure
1. Error Handling Patterns
- Console formatting requirements with examples
- Error wrapping with
%w best practices
- Debug logging standards
- Panic recovery (when/how to use)
2. Common Error Scenarios
- MCP configuration errors → recovery steps
- Permission validation errors → suggested fixes
- Network/firewall errors → debugging steps
- Workflow compilation errors → resolution guide
3. Error Message Templates
- Validation error template with example
- Runtime error template with context
- User-actionable error template
- System/internal error template
4. Debugging Runbook
- How to enable DEBUG logging
- Reading error chains with
errors.As/errors.Is
- Analyzing validation failures
- Troubleshooting MCP server issues
5. Error Categorization
- User errors (fixable by user)
- Configuration errors (workflow changes needed)
- System errors (environment issues)
- Internal errors (code bugs - should be reported)
Acceptance Criteria
Reference Materials
Review existing docs for consistency:
AI generated by Plan Command for discussion #9231
Objective
Create comprehensive documentation for error handling patterns, common error scenarios, recovery strategies, and debugging techniques specific to gh-aw.
Context
Despite 51 references to error handling guides in the codebase, only 1 error message documentation exists. Developers need a comprehensive guide covering error patterns, recovery strategies, and debugging runbooks.
Files to Create/Modify
specs/error-recovery-patterns.mdAGENTS.md(add link to new doc in Available Skills Reference)Documentation Structure
1. Error Handling Patterns
%wbest practices2. Common Error Scenarios
3. Error Message Templates
4. Debugging Runbook
errors.As/errors.Is5. Error Categorization
Acceptance Criteria
specs/error-recovery-patterns.mdAGENTS.mdunder Available Skills ReferenceReference Materials
Review existing docs for consistency:
AGENTS.md- Console formatting guidelinesspecs/error-messages.md- Error message style guidespecs/github-actions-security-best-practices.md- Security error handlingpkg/console/- Console formatting implementationRelated to [plan] Improve Error Experience Engineering across gh-aw #9236