Files

William Valentin a521ed6e9a

Build and Push Docker Image / build-and-push (push) Has been cancelled

Details

Add quick test runner and enhance run_tests script

- 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.

2025-08-05 15:09:13 -07:00

3.8 KiB

Raw Blame History

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 - Complete user manual
- Features and functionality
- Keyboard shortcuts reference
- Theme system and customization
- Usage examples and workflows

For Developers

Developer Guide - Development and testing
- Environment setup and dependencies
- Testing framework and procedures
- Architecture overview
- Code quality standards

Technical Reference

API Reference - Technical documentation
- Export system architecture
- Menu theming implementation
- API specifications
- System internals

Project Information

Main README - Project overview and quick start
Changelog - 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

Reduced Redundancy: Eliminated duplicate content across multiple files
Better Organization: Logical grouping by user type and purpose
Easier Navigation: Clear entry points for different audiences
Comprehensive Coverage: All information preserved and enhanced
Maintainability: Fewer files to keep synchronized

I want to...

Use the application → User Guide
Develop or contribute → Developer Guide
Understand the technical details → API Reference
See what's new → Changelog
Get started quickly → Main README

I'm looking for...

Features and shortcuts → User Guide
Testing information → Developer Guide
Export functionality → API Reference
Installation instructions → Main README

📊 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

3.8 KiB Raw Blame History