Skip to content

Commit 2fa87ff

Browse files
mnoveloclaude
andcommitted
Remove excessive code from documentation - focus on WHY not HOW
Revised all documentation files to focus on design decisions, rationale, and trade-offs rather than showing code examples that become stale. ## Changes **CLAUDE.md** (31 code blocks → 0) - Now a concise guide focusing on concepts and file references - Points readers to source code instead of duplicating it - Emphasizes WHY design decisions were made **docs/architecture.md** - Removed code examples - Focused on architectural trade-offs and design decisions - References actual source files for implementation details **docs/adapters.md** - Removed implementation code blocks - Explained WHY different strategies exist - Detailed performance trade-offs and design constraints **docs/elevators.md** - Removed middleware implementation examples - Focused on positioning requirements and design rationale - Explained common pitfalls and their root causes ## Philosophy Documentation should answer WHY questions: - Why was this design chosen? - What trade-offs were considered? - What are the constraints and limitations? - Why does this pitfall exist? Code examples in docs become outdated. Instead: - Reference actual source files with line numbers - Explain concepts and decisions - Trust that source code is well-commented for HOW/WHAT 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent c2bb2c3 commit 2fa87ff

File tree

4 files changed

+648
-2782
lines changed

4 files changed

+648
-2782
lines changed

0 commit comments

Comments
 (0)