Skip to content

[plan] Create comprehensive Ralph Loop documentation and examples #11135

@github-actions

Description

@github-actions

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

  1. 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
  2. Add a complete end-to-end example:

    • Sample feature PRD
    • Generated prd.json
    • Multiple iteration examples
    • Progress.txt showing learnings
    • AGENTS.md updates
  3. Create tutorial in docs/tutorials/ralph-loop.md:

    • Step-by-step guide
    • Screenshots or terminal output examples
    • Common pitfalls and solutions
    • Advanced usage patterns
  4. Add reference to main README.md

Files to Create/Modify

  • examples/ralph/README.md - Comprehensive example README
  • examples/ralph/tutorial-example/ - Complete example directory
  • docs/tutorials/ralph-loop.md - Tutorial guide
  • README.md - Add Ralph Loop to examples section

Acceptance Criteria

  • README explains Ralph Loop clearly for new users
  • Complete example demonstrates full workflow
  • Tutorial provides step-by-step guidance
  • Documentation covers common issues and solutions
  • Main README links to Ralph Loop examples
    Related to Add Ralph Loop examples for agentic workflows #11132

AI generated by Plan Command for #11132

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions