422617eb6c
- Added a link to the Recent Improvements section in the README.md for better visibility of new features. - Removed the SEARCH_FILTER_FIX.md file as its content has been integrated into other documentation. - Deleted the consolidate_docs.py script as its functionality is no longer needed after the documentation consolidation. - Removed the outdated CHANGELOG.md file and replaced it with a new structure that consolidates all changelog information. - Created a new DOCUMENTATION_INDEX.md file to provide a comprehensive guide to the documentation structure. - Updated the docs/README.md to reflect the new documentation organization and included links to preserved legacy documentation.
114 lines
4.3 KiB
Markdown
114 lines
4.3 KiB
Markdown
# TheChart Documentation Index
|
||
|
||
## 📚 Consolidated Documentation Structure
|
||
|
||
This documentation has been **consolidated and reorganized** for better navigation and reduced redundancy.
|
||
|
||
### 🎯 Main Documentation (Root Level)
|
||
|
||
#### For Users
|
||
- **[User Guide](../USER_GUIDE.md)** - Complete user manual
|
||
- Features and functionality
|
||
- Keyboard shortcuts reference
|
||
- Theme system and customization
|
||
- Usage examples and workflows
|
||
|
||
#### For Developers
|
||
- **[Developer Guide](../DEVELOPER_GUIDE.md)** - Development and testing
|
||
- Environment setup and dependencies
|
||
- Testing framework and procedures
|
||
- Architecture overview
|
||
- Code quality standards
|
||
|
||
#### Technical Reference
|
||
- **[API Reference](../API_REFERENCE.md)** - Technical documentation
|
||
- Export system architecture
|
||
- Menu theming implementation
|
||
- API specifications
|
||
- System internals
|
||
|
||
#### Project Information
|
||
- **[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
|
||
|
||
## <20>️ 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*
|