# DSL TUI Documentation Index
Complete index of all DSL TUI documentation files.
## 📚 User Documentation
### Essential Guides
- **[README.md](README.md)** - Documentation overview and quick start
- **[user-guide.md](user-guide.md)** - Complete user guide (comprehensive)
- **[shortcuts.md](shortcuts.md)** - Keyboard shortcuts reference
- **[troubleshooting.md](troubleshooting.md)** - Common issues and solutions
### Quick Reference
- **[HELP_QUICK_REFERENCE.md](HELP_QUICK_REFERENCE.md)** - Quick reference card
## 🏗️ Developer Documentation
### Architecture & Design
- **[architecture.md](architecture.md)** - Complete architecture documentation
- **[developer-guide.md](developer-guide.md)** - Development workflow and contributing
- **[architecture_design.md](architecture_design.md)** - Initial architecture design
- **[architecture_analysis.md](architecture_analysis.md)** - Architecture analysis
### Implementation Guides
- **[implementation_roadmap.md](implementation_roadmap.md)** - Implementation roadmap
- **[IMPLEMENTATION_SUMMARY.md](IMPLEMENTATION_SUMMARY.md)** - Implementation summary
- **[01-core-app-implementation.md](01-core-app-implementation.md)** - Core app implementation
### Component Documentation
- **[file_manager_implementation.md](file_manager_implementation.md)** - File manager component
- **[editor_design.md](editor_design.md)** - Editor component design
- **[generator_view.md](generator_view.md)** - AI generator view
- **[state_browser_implementation.md](state_browser_implementation.md)** - State browser
- **[state_browser_guide.md](state_browser_guide.md)** - State browser guide
- **[viewer.md](viewer.md)** - Workflow viewer component
- **[help-system.md](help-system.md)** - Help system implementation
## 🧪 Testing Documentation
- **[TEST_README.md](TEST_README.md)** - Test suite overview
- **[TEST_SUITE.md](TEST_SUITE.md)** - Complete test documentation
## 📖 Embedded Help Content
Located in `src/tui/help/docs/`:
- **[quick_start.md](../../src/tui/help/docs/quick_start.md)** - Quick start guide (embedded)
- **[context_help.md](../../src/tui/help/docs/context_help.md)** - Context-sensitive help
- **[user_guide.md](../../src/tui/help/docs/user_guide.md)** - User guide (embedded version)
## 📊 Documentation Structure
```
docs/tui/
├── README.md # Documentation overview
├── DOCUMENTATION_INDEX.md # This file
│
├── User Documentation/
│ ├── user-guide.md # Complete user guide
│ ├── shortcuts.md # Keyboard shortcuts
│ ├── troubleshooting.md # Troubleshooting guide
│ └── HELP_QUICK_REFERENCE.md # Quick reference
│
├── Developer Documentation/
│ ├── architecture.md # Architecture documentation
│ ├── developer-guide.md # Developer guide
│ ├── architecture_design.md # Design documents
│ ├── architecture_analysis.md
│ └── implementation_roadmap.md
│
├── Component Documentation/
│ ├── file_manager_implementation.md
│ ├── editor_design.md
│ ├── generator_view.md
│ ├── state_browser_implementation.md
│ ├── state_browser_guide.md
│ ├── viewer.md
│ └── help-system.md
│
├── Testing Documentation/
│ ├── TEST_README.md
│ └── TEST_SUITE.md
│
└── Implementation Documentation/
├── 01-core-app-implementation.md
└── IMPLEMENTATION_SUMMARY.md
src/tui/help/docs/
├── quick_start.md # Embedded quick start
├── context_help.md # Context-sensitive help
└── user_guide.md # Embedded user guide
```
## 🎯 Documentation by Audience
### For End Users
Start here:
1. [README.md](README.md) - Overview
2. [user-guide.md](user-guide.md) - Complete guide
3. [shortcuts.md](shortcuts.md) - Keyboard shortcuts
4. [troubleshooting.md](troubleshooting.md) - If you have issues
### For Developers
Start here:
1. [architecture.md](architecture.md) - Understand the design
2. [developer-guide.md](developer-guide.md) - Set up development
3. Component documentation - Study specific components
4. [TEST_SUITE.md](TEST_SUITE.md) - Understand testing
### For Contributors
Start here:
1. [developer-guide.md](developer-guide.md) - Contributing workflow
2. [architecture.md](architecture.md) - Design patterns
3. [implementation_roadmap.md](implementation_roadmap.md) - Future work
## 📝 Documentation Standards
All documentation follows these standards:
### Structure
- Clear table of contents
- Hierarchical organization
- Cross-references between docs
- Examples and code snippets
- Version and last updated date
### Content
- **User docs**: Task-focused, tutorial style
- **Developer docs**: Technical, reference style
- **Component docs**: Implementation details
- **Testing docs**: Test coverage and strategy
### Formatting
- Markdown with GitHub flavor
- Code blocks with language tags
- Tables for structured data
- Callouts for important info
- Links to related docs
## 🔄 Documentation Maintenance
### Updating Documentation
When making changes:
1. **User-facing changes**: Update user-guide.md
2. **Architecture changes**: Update architecture.md
3. **New features**: Update relevant component docs
4. **API changes**: Update developer-guide.md
5. **Bug fixes**: Add to troubleshooting.md
### Version Tracking
All documentation files include:
- **Version**: Current version number
- **Last Updated**: Date of last modification
### Review Checklist
Before committing documentation changes:
- [ ] All links work
- [ ] Code examples are tested
- [ ] Screenshots are current (if applicable)
- [ ] Version number updated
- [ ] Last updated date current
- [ ] Cross-references updated
- [ ] Index files updated
## 📚 External Resources
### Related Documentation
- [Main Project README](../../README.md)
- [CLAUDE.md](../../CLAUDE.md) - Project instructions
- [DSL Documentation](../DSL_IMPLEMENTATION.md)
### Rust Documentation
- [Ratatui](https://ratatui.rs/) - Terminal UI framework
- [Crossterm](https://docs.rs/crossterm/) - Terminal manipulation
- [Tokio](https://tokio.rs/) - Async runtime
### Architecture References
- [Hexagonal Architecture](https://alistair.cockburn.us/hexagonal-architecture/)
- [Clean Architecture](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html)
## 🔍 Finding Documentation
### By Topic
**Getting Started**:
- Quick Start: [src/tui/help/docs/quick_start.md](../../src/tui/help/docs/quick_start.md)
- User Guide: [user-guide.md](user-guide.md)
- README: [README.md](README.md)
**Using Features**:
- Workflows: [user-guide.md#working-with-workflows](user-guide.md#working-with-workflows)
- Execution: [user-guide.md#executing-workflows](user-guide.md#executing-workflows)
- State: [user-guide.md#managing-state](user-guide.md#managing-state)
- Shortcuts: [shortcuts.md](shortcuts.md)
**Troubleshooting**:
- Common Issues: [troubleshooting.md](troubleshooting.md)
- Help System: [src/tui/help/docs/context_help.md](../../src/tui/help/docs/context_help.md)
**Development**:
- Architecture: [architecture.md](architecture.md)
- Developer Guide: [developer-guide.md](developer-guide.md)
- Testing: [TEST_SUITE.md](TEST_SUITE.md)
**Components**:
- File Manager: [file_manager_implementation.md](file_manager_implementation.md)
- Editor: [editor_design.md](editor_design.md)
- State Browser: [state_browser_implementation.md](state_browser_implementation.md)
### By Task
**I want to...**
- **Learn to use TUI**: Start with [user-guide.md](user-guide.md)
- **Find keyboard shortcuts**: See [shortcuts.md](shortcuts.md)
- **Fix an issue**: Check [troubleshooting.md](troubleshooting.md)
- **Understand design**: Read [architecture.md](architecture.md)
- **Start developing**: Follow [developer-guide.md](developer-guide.md)
- **Add a feature**: Read [developer-guide.md#adding-features](developer-guide.md#adding-features)
- **Write tests**: See [TEST_SUITE.md](TEST_SUITE.md)
- **Get context help**: Press F1 in TUI or see [context_help.md](../../src/tui/help/docs/context_help.md)
## 📊 Documentation Coverage
### Completeness Status
| User Documentation | ✅ Complete | 4 |
| Developer Documentation | ✅ Complete | 5 |
| Component Documentation | ✅ Complete | 7 |
| Testing Documentation | ✅ Complete | 2 |
| Embedded Help | ✅ Complete | 3 |
### Documentation Statistics
- **Total Documentation Files**: 21+
- **User-Facing Docs**: 7
- **Developer Docs**: 14+
- **Total Pages**: ~150+ pages
- **Code Examples**: 100+
- **Last Updated**: 2025-10-21
## 🎯 Next Steps
### For Users
1. Read the [User Guide](user-guide.md)
2. Try the TUI with your workflows
3. Consult [Shortcuts](shortcuts.md) as needed
4. Report issues or suggestions
### For Developers
1. Review [Architecture](architecture.md)
2. Set up development environment per [Developer Guide](developer-guide.md)
3. Pick a component to contribute to
4. Submit pull requests
## 📧 Feedback
Found an issue with documentation?
- File an issue in the project repository
- Suggest improvements
- Submit documentation PRs
---
**Documentation Version**: 1.0.0
**Last Updated**: 2025-10-21
**Maintained By**: Project Team