Objective
Create comprehensive documentation and a real-world example demonstrating the complete Ralph Loop pattern with gh-aw agentic workflows.
Context
After implementing the core Ralph Loop workflows, we need clear documentation and a practical example that shows the full workflow in action.
Approach
-
Create examples/ralph/README.md with:
- Overview of Ralph Loop pattern
- How to use Ralph with gh-aw
- Complete workflow from PRD to completion
- Comparison with bash-based Ralph
- Best practices and tips
-
Add a complete end-to-end example:
- Sample feature PRD
- Generated prd.json
- Multiple iteration examples
- Progress.txt showing learnings
- AGENTS.md updates
-
Create tutorial in docs/tutorials/ralph-loop.md:
- Step-by-step guide
- Screenshots or terminal output examples
- Common pitfalls and solutions
- Advanced usage patterns
-
Add reference to main README.md
Files to Create/Modify
examples/ralph/README.md - Comprehensive example READMEexamples/ralph/tutorial-example/ - Complete example directorydocs/tutorials/ralph-loop.md - Tutorial guideREADME.md - Add Ralph Loop to examples section
Acceptance Criteria
AI generated by Plan Command for #11132
Objective
Create comprehensive documentation and a real-world example demonstrating the complete Ralph Loop pattern with gh-aw agentic workflows.
Context
After implementing the core Ralph Loop workflows, we need clear documentation and a practical example that shows the full workflow in action.
Approach
Create
examples/ralph/README.mdwith:Add a complete end-to-end example:
Create tutorial in
docs/tutorials/ralph-loop.md:Add reference to main README.md
Files to Create/Modify
examples/ralph/README.md- Comprehensive example READMEexamples/ralph/tutorial-example/- Complete example directorydocs/tutorials/ralph-loop.md- Tutorial guideREADME.md- Add Ralph Loop to examples sectionAcceptance Criteria
Related to Add Ralph Loop examples for agentic workflows #11132