Commit Graph

2 Commits

Author SHA1 Message Date
rob 6135d42bc0 docs: comprehensive AI configuration documentation update
Major documentation updates to align with multi-provider AI system:

1. Update CLAUDE.md (lines 213-332)
   - Add new "AI Configuration System" section
   - Document config/ai.yml structure and three optimization levels
   - Explain model hint propagation pipeline (rule → runner → patcher)
   - Add provider setup table (Claude, Codex, Gemini)
   - Document Claude subagent setup with ./tools/setup_claude_agents.sh
   - List implementation modules with line number references
   - Explain environment variable overrides
   - Document fallback behavior when all providers fail

2. Update docs/DESIGN.md (lines 894-1077)
   - Add "Automation AI Configuration" section before Stage Model
   - Document configuration architecture with full YAML example
   - Explain model hint system with .ai-rules.yml examples
   - Detail execution flow through 4 steps (rule eval → prompt → chain → fallback)
   - Show example prompt with TASK COMPLEXITY hint injection
   - Add provider comparison table with fast/default/quality models
   - Document implementation modules with line references
   - Add cost optimization examples (93% savings on simple tasks)
   - Explain environment overrides and persistence

3. Update docs/AUTOMATION.md (lines 70-148)
   - Restructure Phase 2 requirements to emphasize config/ai.yml
   - Add full YAML configuration example with three chains
   - Explain how model hints work (fast vs quality)
   - Update Claude subagent documentation
   - Clarify auto-selection based on TASK COMPLEXITY
   - Move git config to deprecated status
   - Emphasize environment variables as optional overrides

4. Update README.md (line 10)
   - Add "Multi-Provider AI System" to key features
   - Brief mention of fallback chains and model selection

Impact:
- AI assistants can now discover the multi-provider system
- Users understand how to configure providers via config/ai.yml
- Clear explanation of cost optimization through model hints
- Complete documentation of the execution pipeline
- All major docs now reference the same configuration approach

Resolves documentation gap identified in project review.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-01 21:48:25 -03:00
rob 536d885b6b docs: Add CLAUDE.md and restructure DESIGN.md for clarity
Major documentation improvements:

1. Add CLAUDE.md
   - Comprehensive guide for AI assistants working in this repo
   - Repository architecture and directory structure
   - Common development commands and workflows
   - Build system explanation
   - Key concepts and design philosophy

2. Restructure DESIGN.md
   - Clarify three directory contexts: CascadingDev Repo, Install Bundle, User Project
   - Add clear section headers and visual separation
   - Mark future/unimplemented features with 🚧 emoji
   - Document undocumented wins: META system and Ramble providers
   - Add comprehensive Ramble documentation (mock and claude providers)
   - Document template META system with code examples

3. Fix setup_project.py
   - Correct error message path (was scripts/hooks/pre-commit, now assets/hooks/pre-commit)

These changes address confusion between tooling source, distribution bundle, and
generated user projects while highlighting sophisticated features like the
self-describing template system and multi-provider Ramble GUI.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-30 12:31:33 -03:00