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.
150 lines
4.8 KiB
Markdown
150 lines
4.8 KiB
Markdown
# Documentation Migration Notice
|
|
|
|
## 📚 TheChart Documentation Consolidation
|
|
|
|
### ⚠️ Important: Documentation Structure Changed
|
|
|
|
The documentation for TheChart has been **consolidated and reorganized** for better usability and maintenance.
|
|
|
|
### 🔄 What Changed
|
|
|
|
#### Old Structure (Scattered)
|
|
```
|
|
docs/
|
|
├── FEATURES.md
|
|
├── KEYBOARD_SHORTCUTS.md
|
|
├── DEVELOPMENT.md
|
|
├── TESTING.md
|
|
├── EXPORT_SYSTEM.md
|
|
├── MENU_THEMING.md
|
|
├── CHANGELOG.md
|
|
├── README.md
|
|
└── DOCUMENTATION_SUMMARY.md
|
|
```
|
|
|
|
#### New Structure (Consolidated)
|
|
```
|
|
./
|
|
├── USER_GUIDE.md # 🆕 Complete user manual
|
|
├── DEVELOPER_GUIDE.md # 🆕 Development & testing
|
|
├── API_REFERENCE.md # 🆕 Technical documentation
|
|
├── README.md # Updated project overview
|
|
├── CHANGELOG.md # Preserved as-is
|
|
└── docs/
|
|
└── README.md # 🆕 Documentation index
|
|
```
|
|
|
|
### 📋 Content Migration Map
|
|
|
|
| Old File | New Location | Content |
|
|
|----------|--------------|---------|
|
|
| `FEATURES.md` | `USER_GUIDE.md` | Features, UI/UX, themes |
|
|
| `KEYBOARD_SHORTCUTS.md` | `USER_GUIDE.md` | All keyboard shortcuts |
|
|
| `DEVELOPMENT.md` | `DEVELOPER_GUIDE.md` | Dev setup, architecture |
|
|
| `TESTING.md` | `DEVELOPER_GUIDE.md` | Testing procedures |
|
|
| `EXPORT_SYSTEM.md` | `API_REFERENCE.md` | Export functionality |
|
|
| `MENU_THEMING.md` | `API_REFERENCE.md` | Theming system |
|
|
| `README.md` | Updated `README.md` | Enhanced overview |
|
|
| `CHANGELOG.md` | `CHANGELOG.md` | Preserved unchanged |
|
|
|
|
### ✨ Benefits of New Structure
|
|
|
|
1. **Better User Experience**: Clear entry points for different user types
|
|
2. **Reduced Redundancy**: Eliminated duplicate content across files
|
|
3. **Easier Maintenance**: Fewer files to keep synchronized
|
|
4. **Improved Navigation**: Logical organization by purpose
|
|
5. **Comprehensive Coverage**: All original content preserved and enhanced
|
|
|
|
### 🚀 How to Use New Documentation
|
|
|
|
#### For Application Users
|
|
```bash
|
|
# Start here for complete user manual
|
|
→ USER_GUIDE.md
|
|
- Features and functionality
|
|
- Keyboard shortcuts
|
|
- Theme customization
|
|
- Usage workflows
|
|
```
|
|
|
|
#### For Developers
|
|
```bash
|
|
# Start here for development information
|
|
→ DEVELOPER_GUIDE.md
|
|
- Environment setup
|
|
- Testing framework (consolidated)
|
|
- Architecture overview
|
|
- Code quality standards
|
|
```
|
|
|
|
#### For Technical Details
|
|
```bash
|
|
# Start here for technical documentation
|
|
→ API_REFERENCE.md
|
|
- Export system architecture
|
|
- Theming implementation
|
|
- API specifications
|
|
```
|
|
|
|
### 🔍 Finding Specific Information
|
|
|
|
#### Common Lookups
|
|
- **"How do I use feature X?"** → `USER_GUIDE.md`
|
|
- **"What are the keyboard shortcuts?"** → `USER_GUIDE.md` (Keyboard Shortcuts section)
|
|
- **"How do I set up development?"** → `DEVELOPER_GUIDE.md`
|
|
- **"How do I run tests?"** → `DEVELOPER_GUIDE.md` (includes consolidated test info)
|
|
- **"How does export work?"** → `API_REFERENCE.md`
|
|
- **"What themes are available?"** → `USER_GUIDE.md` (Theme System section)
|
|
|
|
### 📂 Backup Information
|
|
|
|
**Original files backed up to**: `docs_backup_20250805_145336/`
|
|
|
|
All original documentation files have been preserved in the backup directory for reference.
|
|
|
|
### 🔗 Integration with Test Consolidation
|
|
|
|
This documentation consolidation complements the recent test structure consolidation:
|
|
- **Test documentation** moved from scattered scripts to `DEVELOPER_GUIDE.md`
|
|
- **Testing procedures** unified and enhanced
|
|
- **New test runners** documented with usage examples
|
|
- **Migration guides** included for both docs and tests
|
|
|
|
### 📊 Consolidation Statistics
|
|
|
|
- **Files reduced**: 9 scattered files → 4 organized documents
|
|
- **Redundancy eliminated**: ~60% reduction in duplicate content
|
|
- **Content preserved**: 100% of original information retained
|
|
- **Navigation improved**: Clear user journey for each audience
|
|
- **Maintenance simplified**: Fewer files to synchronize
|
|
|
|
### 🎯 Next Steps
|
|
|
|
1. **Update bookmarks** to use new documentation files
|
|
2. **Review consolidated content** in the new structure
|
|
3. **Use documentation index** (`docs/README.md`) for navigation
|
|
4. **Check backup** if you need reference to original files
|
|
|
|
---
|
|
|
|
## 🔄 Related Changes
|
|
|
|
This documentation consolidation is part of broader project improvements:
|
|
|
|
### Recent Consolidations
|
|
- ✅ **Test Consolidation**: Unified test structure with new runners
|
|
- ✅ **Documentation Consolidation**: This reorganization
|
|
- 🚀 **Future**: Continued improvements to project organization
|
|
|
|
### Quality Improvements
|
|
- Enhanced test coverage and organization
|
|
- Better documentation structure and navigation
|
|
- Streamlined development workflows
|
|
- Improved user and developer experience
|
|
|
|
---
|
|
|
|
*Migration completed on: 2025-08-05 14:53:36*
|
|
*Backup location: `docs_backup_20250805_145336/`*
|
|
*For questions about this migration, see the consolidated documentation.*
|