# TheChart Documentation Hub ## 📚 Complete Documentation Access ### 🎯 **Main Documentation** - **[📖 CONSOLIDATED DOCS](../CONSOLIDATED_DOCS.md)** - **Complete comprehensive guide (RECOMMENDED)** - **[🚀 README](../README.md)** - Quick start and project overview - **[👤 USER GUIDE](../USER_GUIDE.md)** - User manual and features - **[🛠️ DEVELOPER GUIDE](../DEVELOPER_GUIDE.md)** - Development and architecture ### 🔧 **Specialized Topics** - **[🐛 UI Flickering Fix](../UI_FLICKERING_FIX_SUMMARY.md)** - Latest performance improvements - **[📋 CHANGELOG](../CHANGELOG.md)** - Version history and updates - **[🔧 API REFERENCE](../API_REFERENCE.md)** - Technical API documentation - **[✨ IMPROVEMENTS](../IMPROVEMENTS_SUMMARY.md)** - Recent feature additions --- ## 🎯 Quick Navigation by Role ### 📱 **New Users** Start here: **[CONSOLIDATED DOCS - User Guide Section](../CONSOLIDATED_DOCS.md#-user-guide)** - Application overview and features - Getting started guide - Keyboard shortcuts - Settings and customization ### 👨‍💻 **Developers** Start here: **[CONSOLIDATED DOCS - Developer Guide Section](../CONSOLIDATED_DOCS.md#-developer-guide)** - Environment setup - Project architecture - Testing procedures - API reference ### 🔍 **Looking for Specific Information** #### Features & Capabilities → **[CONSOLIDATED DOCS - Features Section](../CONSOLIDATED_DOCS.md#-features--capabilities)** #### Technical Details → **[CONSOLIDATED DOCS - Technical Architecture](../CONSOLIDATED_DOCS.md#-technical-architecture)** #### Recent Updates → **[CONSOLIDATED DOCS - Recent Improvements](../CONSOLIDATED_DOCS.md#-recent-improvements)** #### Troubleshooting → **[CONSOLIDATED DOCS - Troubleshooting](../CONSOLIDATED_DOCS.md#-troubleshooting)** --- ## 📋 Documentation Structure ### Primary Documents (Root Level) - **CONSOLIDATED_DOCS.md** - ⭐ **Complete documentation in one place** - README.md - Project overview and quick start - USER_GUIDE.md - Comprehensive user manual - DEVELOPER_GUIDE.md - Development guide - CHANGELOG.md - Version history - API_REFERENCE.md - Technical documentation ### Specialized Documents - UI_FLICKERING_FIX_SUMMARY.md - Performance improvement details - IMPROVEMENTS_SUMMARY.md - Feature enhancement summary ### Legacy/Reference (docs/ folder) - Individual topic files preserved for reference - Historical documentation versions - Specialized technical documents --- ## 💡 **Recommendation** **For the most comprehensive and up-to-date information, we recommend starting with:** ### 🌟 [**CONSOLIDATED_DOCS.md**](../CONSOLIDATED_DOCS.md) This single document contains: - ✅ Complete user guide - ✅ Full developer documentation - ✅ Technical architecture details - ✅ Recent improvements and fixes - ✅ API reference - ✅ Troubleshooting guide - ✅ Quick start instructions - **[Main README](../README.md)** - Project overview and quick start - **[Changelog](../CHANGELOG.md)** - Version history and release notes - **[Recent Improvements](../IMPROVEMENTS_SUMMARY.md)** - Latest enhancements and new features ## �️ Legacy Reference Files The following specialized documentation files are preserved in the docs/ folder: ### Feature Documentation - **[FEATURES.md](FEATURES.md)** - Original feature documentation (consolidated into USER_GUIDE.md) - **[KEYBOARD_SHORTCUTS.md](KEYBOARD_SHORTCUTS.md)** - Original shortcuts reference (consolidated into USER_GUIDE.md) - **[EXPORT_SYSTEM.md](EXPORT_SYSTEM.md)** - Original export documentation (consolidated into API_REFERENCE.md) - **[MENU_THEMING.md](MENU_THEMING.md)** - Original theming documentation (consolidated into API_REFERENCE.md) ### Development Documentation - **[DEVELOPMENT.md](DEVELOPMENT.md)** - Original development guide (consolidated into DEVELOPER_GUIDE.md) - **[TESTING.md](TESTING.md)** - Original testing documentation (consolidated into DEVELOPER_GUIDE.md) ### System Documentation - **[DOCUMENTATION_SUMMARY.md](DOCUMENTATION_SUMMARY.md)** - Documentation organization summary > **Note**: These files are preserved for reference but their content has been consolidated into the main documentation files for better organization and reduced redundancy. --- **📖 For complete documentation navigation, see: [DOCUMENTATION_INDEX.md](DOCUMENTATION_INDEX.md)** 5. **Maintainability**: Fewer files to keep synchronized ### 🚀 Quick Navigation #### I want to... - **Use the application** → [User Guide](../USER_GUIDE.md) - **Develop or contribute** → [Developer Guide](../DEVELOPER_GUIDE.md) - **Understand the technical details** → [API Reference](../API_REFERENCE.md) - **See what's new** → [Changelog](../CHANGELOG.md) - **Get started quickly** → [Main README](../README.md) #### I'm looking for... - **Features and shortcuts** → [User Guide](../USER_GUIDE.md) - **Testing information** → [Developer Guide](../DEVELOPER_GUIDE.md) - **Export functionality** → [API Reference](../API_REFERENCE.md) - **Installation instructions** → [Main README](../README.md) ### 📊 Documentation Statistics - **Total Documents**: 4 main documents (was 9+ scattered files) - **Content Coverage**: 100% of original content preserved - **Redundancy Reduction**: ~60% reduction in duplicate information - **Navigation Improvement**: Single entry point per user type ### 🔄 Migration Information This consolidation was performed to: - Improve documentation discoverability - Reduce maintenance overhead - Provide clearer user journeys - Eliminate content duplication - Create better developer experience **Previous structure**: Multiple scattered files with overlapping content **New structure**: 4 comprehensive, well-organized documents --- ## 🆕 Recent Documentation Updates ### Test Consolidation Integration The documentation now includes comprehensive information about the recently consolidated test structure: - Unified test framework documentation - New test runner usage - Quick test categories for development - Migration guide for test changes ### Enhanced User Experience - Consolidated keyboard shortcuts in User Guide - Complete theme system documentation - Streamlined feature explanations - Better cross-referencing between documents --- *Documentation consolidated on {datetime.now().strftime("%Y-%m-%d")}* *See `DOCS_MIGRATION.md` for detailed migration information*