Draft: Add comprehensive CLAUDE.md documentation for Raider framework

Lars Gollnowrequested to merge
threaded-raider into main
  • Create new CLAUDE.md with complete architecture overview and usage patterns
  • Document core concepts: Apps, Agents, Tasks, Providers, LLMs, Runners
  • Add execution flow diagram and context hierarchy explanation
  • Include development commands: setup, testing, linting, console
  • Document advanced usage patterns from production baim application:
    • Agent DSL pattern for task orchestration with blocks
    • Tool definition pattern with ToolBase subclassing
    • Task structure best practices with JSON responses
    • Conditional task execution and early exit patterns
    • Response helpers pattern (ag.response_from)
    • Retry and error handling strategies
    • Task aliasing with as: parameter
    • Rails integration with Raider::App and Raider::Source models
    • Lifecycle hooks configuration and usage
  • Add tool calling explanation with lifecycle hooks
  • Document three-level context system (AppContext, AgentContext, TaskContext)
  • Include logging and VCR configuration details
  • List key dependencies and their purposes
  • Document RuboCop style guidelines (Ruby 3.4, 120 char line length)

This documentation provides both fundamental architecture from the gem itself and real-world advanced patterns from production usage in the baim application, making it valuable for future Claude Code sessions and developers.

Merge request reports