a521ed6e9a
Some checks failed
Build and Push Docker Image / build-and-push (push) Has been cancelled
- Introduced `quick_test.py` for running specific test categories (unit, integration, theme, all). - Updated `run_tests.py` to improve test execution and reporting, including coverage. - Removed outdated test scripts for keyboard shortcuts, menu theming, note saving, and entry updating. - Added new test script `test_theme_changing.py` to verify theme changing functionality. - Consolidated integration tests into `test_integration.py` for comprehensive testing of TheChart application. - Updated theme manager to ensure color retrieval works correctly. - Modified test constants to import from the correct module path.
108 lines
3.8 KiB
Markdown
108 lines
3.8 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
|
|
|
|
### 📁 Legacy Documentation (Preserved)
|
|
|
|
The following files are preserved for reference but content has been consolidated:
|
|
|
|
#### Original Structure
|
|
- `FEATURES.md` → Content moved to `USER_GUIDE.md`
|
|
- `KEYBOARD_SHORTCUTS.md` → Content moved to `USER_GUIDE.md`
|
|
- `DEVELOPMENT.md` → Content moved to `DEVELOPER_GUIDE.md`
|
|
- `TESTING.md` → Content moved to `DEVELOPER_GUIDE.md`
|
|
- `EXPORT_SYSTEM.md` → Content moved to `API_REFERENCE.md`
|
|
- `MENU_THEMING.md` → Content moved to `API_REFERENCE.md`
|
|
|
|
#### Migration Benefits
|
|
1. **Reduced Redundancy**: Eliminated duplicate content across multiple files
|
|
2. **Better Organization**: Logical grouping by user type and purpose
|
|
3. **Easier Navigation**: Clear entry points for different audiences
|
|
4. **Comprehensive Coverage**: All information preserved and enhanced
|
|
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*
|