mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-01-09 13:10:24 -06:00
b880191c16
Timer/Editing - Add/edit time-entry UI and flows in templates (`templates/timer/*`) - Extend timer and API routes (`app/routes/timer.py`, `app/routes/api.py`) - Update mobile interactions (`app/static/mobile.js`) Invoices/PDF - Improve invoice model and route handling (`app/models/invoice.py`, `app/routes/invoices.py`) - Enhance PDF generation and fallback logic (`app/utils/pdf_generator*.py`) - Adjust invoice view layout (`templates/invoices/view.html`) Docker/Startup - Refine Docker build and startup paths (`Dockerfile`) - Improve init/entrypoint scripts (`docker/init-database-*.py`, new `docker/entrypoint*.sh`, `docker/entrypoint.py`) - General startup robustness and permissions fixes Docs/UI - Refresh README and Docker docs (setup, troubleshooting, structure) - Minor UI/help updates (`templates/main/help.html`, `templates/projects/create.html`) - Remove obsolete asset (`assets/screenshots/Task_Management.png`) - Add repo hygiene updates (e.g., `.gitattributes`)
TimeTracker Documentation
Welcome to the TimeTracker documentation. This directory contains comprehensive documentation for all aspects of the application.
📚 Documentation Index
🚀 Getting Started
- README.md - Main project overview and quick start guide
- REQUIREMENTS.md - System requirements and dependencies
- PROJECT_STRUCTURE.md - Detailed project architecture
🐳 Docker & Deployment
- DOCKER_PUBLIC_SETUP.md - Public Docker deployment guide
- DOCKER_STARTUP_TROUBLESHOOTING.md - Docker troubleshooting
- SOLUTION_GUIDE.md - Common problems and solutions
🔧 Features
- TASK_MANAGEMENT.md - Task management system overview
- TASK_MANAGEMENT_README.md - Detailed task management guide
- INVOICE_FEATURE_README.md - Invoice system documentation
- ENHANCED_INVOICE_SYSTEM_README.md - Advanced invoice features
- INVOICE_INTERFACE_IMPROVEMENTS.md - Invoice UI improvements
- Analytics and reporting features (see the Reports section in the app)
- MOBILE_IMPROVEMENTS.md - Mobile interface enhancements
🛠️ Technical Details
- LOGO_UPLOAD_SYSTEM_README.md - Logo upload functionality
- LOGO_UPLOAD_IMPLEMENTATION_SUMMARY.md - Logo system implementation
- PDF_GENERATION_TROUBLESHOOTING.md - PDF generation issues and fixes
📋 Project Guidelines
- CODE_OF_CONDUCT.md - Community guidelines
- CONTRIBUTING.md - How to contribute to the project
- GITHUB_WORKFLOW_IMAGES.md - GitHub workflow documentation
🔍 Quick Navigation
For New Users
- Start with the main README.md
- Check REQUIREMENTS.md for system requirements
- Review PROJECT_STRUCTURE.md for architecture overview
For Developers
- Read CONTRIBUTING.md for contribution guidelines
- Review feature-specific documentation for areas you're working on
- Check SOLUTION_GUIDE.md for common issues
For Deployment
- Review DOCKER_PUBLIC_SETUP.md for Docker deployment
- Check DOCKER_STARTUP_TROUBLESHOOTING.md if you encounter issues
- See SOLUTION_GUIDE.md for deployment solutions
📝 Documentation Structure
All documentation files are organized by category and purpose:
- Feature Documentation: Explains specific application features
- Technical Guides: Implementation details and technical information
- Deployment Guides: Setup and deployment instructions
- Troubleshooting: Common issues and their solutions
- Project Guidelines: Community and contribution guidelines
🤝 Contributing to Documentation
If you find errors or want to improve the documentation:
- Check the CONTRIBUTING.md guidelines
- Make your changes
- Submit a pull request
Good documentation helps everyone use and contribute to the project effectively!