33d7ae8d9f
- Deleted `TESTING_SETUP.md` and `TEST_UPDATES_SUMMARY.md` as they were outdated. - Introduced `CHANGELOG.md` to document notable changes and version history. - Added `DEVELOPMENT.md` for detailed development setup, testing framework, and debugging guidance. - Created `FEATURES.md` to outline core features and functionalities of TheChart. - Established `README.md` as a centralized documentation index for users and developers.
3.2 KiB
3.2 KiB
TheChart Documentation
Welcome to TheChart documentation! This guide will help you navigate the available documentation.
📖 Documentation Index
For Users
- README.md - Quick start guide and installation
- Features Guide - Complete feature documentation
- Modular Medicine System
- Advanced Dose Tracking
- Graph Visualizations
- Data Management
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 updates and improvements
- Migration notes
- Future roadmap
🚀 Quick Navigation
Getting Started
- Installation: See README.md - Installation
- First Run: See README.md - Running the Application
- Key Features: See FEATURES.md
Development
- Setup: See DEVELOPMENT.md - Development Environment Setup
- Testing: See DEVELOPMENT.md - Testing Framework
- Contributing: See DEVELOPMENT.md - Development Workflow
Advanced Usage
- Medicine Management: See FEATURES.md - Modular Medicine System
- Dose Tracking: See FEATURES.md - Advanced Dose Tracking
- Visualizations: See FEATURES.md - Enhanced Graph Visualization
📋 Documentation Standards
All documentation follows these principles:
- Clear Structure: Hierarchical organization with clear headings
- Practical Examples: Code snippets and usage examples
- Up-to-date: Synchronized with current codebase
- Comprehensive: Covers all major features and workflows
- Cross-referenced: Links between related sections
🔍 Finding Information
By Topic
- Installation & Setup → README.md
- Feature Usage → FEATURES.md
- Development → DEVELOPMENT.md
- Version History → CHANGELOG.md
By User Type
- End Users → Start with README.md, then FEATURES.md
- Developers → DEVELOPMENT.md and CHANGELOG.md
- Contributors → All documentation, especially DEVELOPMENT.md
By Task
- Install TheChart → README.md - Installation
- Add New Medicine → FEATURES.md - Modular Medicine System
- Track Doses → FEATURES.md - Advanced Dose Tracking
- Run Tests → DEVELOPMENT.md - Testing Framework
- Deploy Application → README.md - Deployment
Need help? Check the troubleshooting sections in README.md and DEVELOPMENT.md.