will/thechart
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
v1.11.5
thechart/docs/README.md
William Valentin c3c88c63d2
Some checks failed
Build and Push Docker Image / build-and-push (push) Has been cancelled
Details
Add theme management and settings functionality 
- Introduced `ThemeManager` to handle application themes using `ttkthemes`.
- Added `SettingsWindow` for user preferences including theme selection and UI settings.
- Integrated theme selection into the main application with a menu for quick access.
- Enhanced UI components with custom styles based on the selected theme.
- Implemented tooltips for better user guidance across various UI elements.
- Updated dependencies to include `ttkthemes` for improved visual appeal.
2025-08-05 11:58:25 -07:00

5.1 KiB
Raw Permalink Blame History

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 - Quick start guide and installation
  • Features Guide - 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 - 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 - Data export functionality and formats
    • JSON, XML, and PDF export options
    • Graph visualization inclusion
    • Export manager architecture

For Developers

  • Development Guide - Development setup and testing
    • Testing Framework (93% coverage)
    • Code Quality Tools
    • Architecture Overview
    • Debugging Guide

Project History

  • Changelog - 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
  2. First Run: See README.md - Running the Application
  3. UI/UX Features: See FEATURES.md - Modern UI/UX System

Using the Application

  1. Theme Selection: See FEATURES.md - Settings and Theme Management
  2. Keyboard Shortcuts: See KEYBOARD_SHORTCUTS.md
  3. Medicine Management: See FEATURES.md - Modular Medicine System
  4. Dose Tracking: See FEATURES.md - Advanced Dose Tracking
  5. Data Export: See EXPORT_SYSTEM.md

Development

  1. Setup: See DEVELOPMENT.md - Development Environment Setup
  2. Testing: See DEVELOPMENT.md - Testing Framework
  3. Architecture: See FEATURES.md - Technical Architecture
  4. Contributing: See 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

By User Type

By Task

Need help? Check the troubleshooting sections in README.md and DEVELOPMENT.md.