README.md
1 # ECHO Documentation 2 3 This directory contains organized documentation for the ECHO project. 4 5 ## Directory Structure 6 7 ### `/guides/` - User Guides 8 Setup instructions, tutorials, and how-to guides for users and developers. 9 10 - **getting-started.md** - Initial setup and first steps 11 - **claude-desktop-setup.md** - Complete Claude Desktop integration guide 12 - **demo-guide.md** - Demo scenarios and examples 13 14 ### `/architecture/` - Architecture Documentation 15 System design, technical architecture, and architectural decision records. 16 17 - **echo-architecture.md** - Complete system architecture overview 18 19 ### `/troubleshooting/` - Troubleshooting & Fixes 20 Common issues, debugging guides, and fix documentation. 21 22 - **elixirls-connection-issue-explained.md** - ElixirLS debugging 23 - **db-id-fix-summary.md** - Database ID fix documentation 24 25 ### `/completed/` - Completed Tasks 26 Historical logs of completed features, migrations, and major tasks. 27 28 - **day2-training-complete.md** - Training completion log 29 - **distributed-context-complete.md** - Context refactoring log 30 - **add-all-agents.md** - Agent addition tracking 31 - **cleanup-list.md** - Cleanup task tracking 32 - **agent-build-test-results.md** - Build test results 33 34 ## Quick Links 35 36 ### For New Users 37 Start here: [guides/getting-started.md](guides/getting-started.md) 38 39 ### For Developers 40 - Architecture: [architecture/echo-architecture.md](architecture/echo-architecture.md) 41 - Claude Desktop: [guides/claude-desktop-setup.md](guides/claude-desktop-setup.md) 42 43 ### For Troubleshooting 44 See: [troubleshooting/](troubleshooting/) 45 46 ## Root Documentation 47 48 The following documentation remains at project root: 49 - **README.md** - Project introduction 50 - **CLAUDE.md** - AI assistant context 51 - **{directory}/claude.md** - Directory-specific contexts 52 53 ## Contributing to Documentation 54 55 When adding new documentation: 56 1. Choose appropriate directory (guides/architecture/troubleshooting) 57 2. Use descriptive filenames (lowercase-with-hyphens.md) 58 3. Update this README with links to new docs 59 4. Cross-reference related documentation