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> |
||
|---|---|---|
| assets | ||
| docs | ||
| src/cascadingdev | ||
| tools | ||
| .gitignore | ||
| CLAUDE.md | ||
| README.md | ||
| VERSION | ||
| pyproject.toml | ||
README.md
CascadingDev (CDev)
CDev — short for Cascading Development — is a Git-native AI–human collaboration framework that automates documentation, discussion summaries, and code review directly within your repository.
It lets you build self-documenting projects where AI assists in generating and maintaining feature discussions, design docs, and implementation plans — all version-controlled alongside your code.
✨ Key Features
- Git-Integrated Workflow — every discussion, decision, and artifact lives in Git.
- Cascading Rules System — nearest
.ai-rules.ymldefines how automation behaves. - Stage-Per-Discussion Model — separate files for feature, design, implementation, testing, and review.
- Pre-commit Hook — automatically maintains summaries, diagrams, and vote tallies.
- Ramble GUI — friendly PySide6/PyQt5 dialog for capturing structured feature requests.
- Deterministic Builds — a reproducible installer bundle you can unzip and run anywhere.
🚀 Quick Start (Developers)
# 1. Create and activate a virtual environment
python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip wheel PySide6
# 2. Build the installer bundle
python tools/build_installer.py
# 3. Test-install into a temporary folder
python install/cascadingdev-*/setup_cascadingdev.py --target /tmp/myproject --no-ramble