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.
107 lines
5.3 KiB
Markdown
107 lines
5.3 KiB
Markdown
# TheChart Documentation
|
||
|
||
Welcome to TheChart documentation! This guide will help you navigate the available documentation for the modern medication tracking application.
|
||
|
||
## 📖 Documentation Index
|
||
|
||
### For Users
|
||
- **[README.md](../README.md)** - Quick start guide and installation
|
||
- **[Features Guide](FEATURES.md)** - Complete feature documentation including new UI/UX improvements
|
||
- Modern Theme System (8 Professional Themes)
|
||
- Advanced Keyboard Shortcuts
|
||
- Smart Tooltip System
|
||
- Modular Medicine System
|
||
- Advanced Dose Tracking
|
||
- Graph Visualizations
|
||
- Data Management
|
||
- **[Keyboard Shortcuts](KEYBOARD_SHORTCUTS.md)** - Comprehensive shortcut reference
|
||
- File operations shortcuts (Ctrl+S, Ctrl+Q, Ctrl+E)
|
||
- Data management shortcuts (Ctrl+N, Ctrl+R, F5)
|
||
- Navigation shortcuts (Ctrl+M, Ctrl+P, F1, F2)
|
||
- **[Export System](EXPORT_SYSTEM.md)** - Data export functionality and formats
|
||
- JSON, XML, and PDF export options
|
||
- Graph visualization inclusion
|
||
- Export manager architecture
|
||
|
||
### For Developers
|
||
- **[Development Guide](DEVELOPMENT.md)** - Development setup and testing
|
||
- Testing Framework (93% coverage)
|
||
- Code Quality Tools
|
||
- Architecture Overview
|
||
- Debugging Guide
|
||
|
||
### Project History
|
||
- **[Changelog](CHANGELOG.md)** - Version history and feature evolution
|
||
- Recent UI/UX overhaul (v1.9.5)
|
||
- Keyboard shortcuts system (v1.7.0)
|
||
- Medicine and dose tracking improvements
|
||
- Migration notes and future roadmap
|
||
|
||
## 🚀 Quick Navigation
|
||
|
||
### Getting Started
|
||
1. **Installation**: See [README.md - Installation](../README.md#installation)
|
||
2. **First Run**: See [README.md - Running the Application](../README.md#running-the-application)
|
||
3. **UI/UX Features**: See [FEATURES.md - Modern UI/UX System](FEATURES.md#-modern-uiux-system-new-in-v195)
|
||
|
||
### Using the Application
|
||
1. **Theme Selection**: See [FEATURES.md - Settings and Theme Management](FEATURES.md#️-settings-and-theme-management)
|
||
2. **Keyboard Shortcuts**: See [KEYBOARD_SHORTCUTS.md](KEYBOARD_SHORTCUTS.md)
|
||
3. **Medicine Management**: See [FEATURES.md - Modular Medicine System](FEATURES.md#-modular-medicine-system)
|
||
4. **Dose Tracking**: See [FEATURES.md - Advanced Dose Tracking](FEATURES.md#-advanced-dose-tracking)
|
||
5. **Data Export**: See [EXPORT_SYSTEM.md](EXPORT_SYSTEM.md)
|
||
|
||
### Development
|
||
1. **Setup**: See [DEVELOPMENT.md - Development Environment Setup](DEVELOPMENT.md#development-environment-setup)
|
||
2. **Testing**: See [TESTING.md](TESTING.md) - Comprehensive testing guide
|
||
3. **Architecture**: See [FEATURES.md - Technical Architecture](FEATURES.md#technical-architecture)
|
||
4. **Contributing**: See [DEVELOPMENT.md - Development Workflow](DEVELOPMENT.md#development-workflow)
|
||
|
||
## 📋 What's New in Documentation
|
||
|
||
### Recent Updates (v1.9.5)
|
||
- **Consolidated Structure**: Merged UI improvements into main features documentation
|
||
- **Enhanced Features Guide**: Added comprehensive UI/UX documentation
|
||
- **Updated Changelog**: Detailed UI/UX overhaul documentation
|
||
- **Improved Navigation**: Better cross-referencing between documents
|
||
|
||
### Documentation Highlights
|
||
- **Professional UI/UX**: Complete documentation of the new theme system
|
||
- **Keyboard Efficiency**: Comprehensive shortcut system documentation
|
||
- **Developer-Friendly**: Enhanced development and testing documentation
|
||
- **User-Focused**: Clear separation of user vs developer documentation
|
||
|
||
## 🔍 Finding Information
|
||
|
||
### By Topic
|
||
- **Installation & Setup** → [README.md](../README.md)
|
||
- **UI/UX and Themes** → [FEATURES.md - Modern UI/UX System](FEATURES.md#-modern-uiux-system-new-in-v195)
|
||
- **Feature Usage** → [FEATURES.md](FEATURES.md)
|
||
- **Keyboard Shortcuts** → [KEYBOARD_SHORTCUTS.md](KEYBOARD_SHORTCUTS.md)
|
||
- **Menu Theming** → [MENU_THEMING.md](MENU_THEMING.md)
|
||
- **Testing** → [TESTING.md](TESTING.md)
|
||
- **Data Export** → [EXPORT_SYSTEM.md](EXPORT_SYSTEM.md)
|
||
- **Development** → [DEVELOPMENT.md](DEVELOPMENT.md)
|
||
- **Version History** → [CHANGELOG.md](CHANGELOG.md)
|
||
|
||
### By User Type
|
||
- **End Users** → Start with [README.md](../README.md), then [FEATURES.md](FEATURES.md)
|
||
- **Power Users** → [KEYBOARD_SHORTCUTS.md](KEYBOARD_SHORTCUTS.md) and [EXPORT_SYSTEM.md](EXPORT_SYSTEM.md)
|
||
- **Developers** → [DEVELOPMENT.md](DEVELOPMENT.md), [TESTING.md](TESTING.md), and [FEATURES.md - Technical Architecture](FEATURES.md#technical-architecture)
|
||
- **Contributors** → All documentation, especially [DEVELOPMENT.md](DEVELOPMENT.md) and [TESTING.md](TESTING.md)
|
||
|
||
### By Task
|
||
- **Install TheChart** → [README.md - Installation](../README.md#installation)
|
||
- **Change Theme** → [FEATURES.md - Settings and Theme Management](FEATURES.md#️-settings-and-theme-management)
|
||
- **Learn Shortcuts** → [KEYBOARD_SHORTCUTS.md](KEYBOARD_SHORTCUTS.md)
|
||
- **Add New Medicine** → [FEATURES.md - Modular Medicine System](FEATURES.md#-modular-medicine-system)
|
||
- **Track Doses** → [FEATURES.md - Advanced Dose Tracking](FEATURES.md#-advanced-dose-tracking)
|
||
- **Export Data** → [EXPORT_SYSTEM.md](EXPORT_SYSTEM.md)
|
||
- **Run Tests** → [TESTING.md](TESTING.md) - Comprehensive testing guide
|
||
- **Debug Issues** → [TESTING.md - Troubleshooting](TESTING.md#troubleshooting)
|
||
- **Deploy Application** → [README.md - Deployment](../README.md#deployment)
|
||
|
||
---
|
||
|
||
**Need help?** Check the troubleshooting sections in [README.md](../README.md#troubleshooting) and [DEVELOPMENT.md](DEVELOPMENT.md#debugging-and-troubleshooting).
|