Welcome to the Rust TUI Coder documentation! This index helps you find the information you need.
** NEW in v0.3.0**: ReAct pattern, OS detection, time tools, custom prompts, and enhanced file operations!
Start here if you're new to Rust TUI Coder:
- README.md - Project overview and features
- GETTING_STARTED.md - Installation and first steps
- EXAMPLES.md - Practical usage examples
Reference these documents during regular use:
- EXAMPLES.md - Common tasks and workflows
- TROUBLESHOOTING.md - Fix common problems
- README.md - Complete feature reference
Technical documentation for contributors and developers:
- ARCHITECTURE.md - System design and structure
- API.md - Complete API reference
- CONTRIBUTING.md - Contribution guidelines
- TESTING.md - Test suite documentation
Documentation for project maintenance:
- PUBLISH.md - Publishing to crates.io
- IMPROVEMENTS_SUMMARY.md - Recent improvements
- COMPLETION_REPORT.md - Development milestone report
- Basic file operations
- Code generation
- Refactoring code
- Debugging assistance
- Project setup
- Real-world scenarios
- Installation issues
- Configuration problems
- API connection issues
- Tool execution errors
- UI/Display problems
- Performance issues
-> EXAMPLES.md
-> API.md
-> TESTING.md
-> PUBLISH.md
Purpose: Main project documentation
Audience: All users
Content:
- Project overview and features
- Installation instructions
- Configuration guide
- Usage instructions
- Available tools
- FAQ and troubleshooting basics
Purpose: Quick start guide for new users
Audience: New users
Content:
- Step-by-step installation
- Configuration walkthrough
- First run experience
- Basic usage tutorial
- Common tasks
- Tips for effective use
Purpose: Practical usage examples
Audience: All users
Content:
- 30+ real-world examples
- Basic to advanced workflows
- Code generation examples
- Refactoring scenarios
- Debugging patterns
- Multi-step projects
Purpose: System design documentation
Audience: Developers and contributors
Content:
- Architecture overview
- Component descriptions
- Data flow diagrams
- Design decisions
- Extension points
- Technical details
Purpose: Complete API reference
Audience: Developers and advanced users
Content:
- Module documentation
- Function signatures
- Type definitions
- Tool descriptions
- Usage examples
- Error handling
Purpose: Contributor guidelines
Audience: Contributors
Content:
- Development setup
- Code style guidelines
- Testing requirements
- Pull request process
- Adding features
- Bug reporting
Purpose: Test suite documentation
Audience: Developers
Content:
- Test organization (94 tests)
- Running tests
- Test coverage details
- Adding new tests
- Test philosophy
Purpose: Problem diagnosis and solutions
Audience: All users
Content:
- Common issues and fixes
- Installation problems
- Configuration errors
- API connection issues
- Tool execution errors
- Platform-specific issues
Purpose: Publishing guide
Audience: Maintainers
Content:
- Pre-publication checklist
- Publishing steps
- Post-publication tasks
- Version management
- Testing installation
Purpose: Recent changes and improvements
Audience: Maintainers and contributors
Content:
- Package metadata improvements
- Test suite additions
- Documentation updates
- Code quality enhancements
Purpose: Development milestone report
Audience: Maintainers
Content:
- Task completion summary
- Key achievements
- Test results
- Documentation deliverables
Q: How do I install it?
A: See Installation
Q: How do I configure it?
A: See Configuration
Q: What API providers are supported?
A: See Provider Configuration
Q: Can I use a local model?
A: Yes! See Local Models
Q: What can it do?
A: See Features and Examples
Q: What tools are available?
A: See Available Tools or API Reference
Q: How do I create a file?
A: See Basic File Operations
Q: How do I execute code?
A: See Code Execution
Q: Can it help with debugging?
A: Yes! See Debugging Assistance
Q: It says config file not found?
A: See Config File Not Found
Q: My API key doesn't work?
A: See Invalid API Key
Q: Connection fails?
A: See Connection Issues
Q: Tool execution fails?
A: See Tool Execution Errors
Q: Display looks weird?
A: See UI Problems
Q: How does it work internally?
A: See Architecture
Q: How can I contribute?
A: See Contributing
Q: How do I add a new tool?
A: See Adding Tools
Q: How do I run tests?
A: See Testing
Q: What's the API for each module?
A: See API Reference
- README.md - Skim the overview
- GETTING_STARTED.md - Follow installation and setup
- EXAMPLES.md - Try example 1-3
- GETTING_STARTED.md - Complete guide
- EXAMPLES.md - Review all examples
- README.md - Read feature reference
- TROUBLESHOOTING.md - Bookmark for later
- README.md - Understand the project
- ARCHITECTURE.md - Learn the design
- API.md - Study the API
- CONTRIBUTING.md - Learn contribution process
- TESTING.md - Understand testing
- CONTRIBUTING.md - Read thoroughly
- ARCHITECTURE.md - Understand internals
- API.md - Reference as needed
- TESTING.md - Follow test guidelines
- Total Documents: 10
- Total Lines: ~5,000+
- Topics Covered: 100+
- Code Examples: 50+
- Last Updated: 2024
- README.md: When adding features or changing behavior
- GETTING_STARTED.md: When setup process changes
- EXAMPLES.md: When adding new use cases
- ARCHITECTURE.md: When changing system design
- API.md: When changing APIs or adding tools
- CONTRIBUTING.md: When changing dev process
- TESTING.md: When adding test suites
- TROUBLESHOOTING.md: When common issues emerge
- Start with the index (this file) to orient yourself
- Use Ctrl+F to search within documents
- Follow links between related topics
- Try examples as you read
- Bookmark frequently used pages
- Keep examples practical and tested
- Update related documents when making changes
- Add cross-references between related topics
- Include code examples where helpful
- Test all code snippets before committing
- Documentation Issues: Open a GitHub issue
- Suggestions: Submit a pull request
- Questions: Start a GitHub discussion
- Rust Book - Learn Rust
- Tokio Tutorial - Async programming
- Ratatui Docs - TUI library
- OpenAI API Docs - API reference
- Anthropic API Docs - Claude API
- Ollama - Local LLM runtime
- LM Studio - Local LLM interface
- cargo-watch - Auto-rebuild tool
**Happy Learning! **
Last Updated: 2024
Version: 1.0.0