CI/CD Documentation — Continuous integration and deployment
- Documentation — CI/CD overview
- Quick Start — Get started with CI/CD
- Implementation Summary — What was implemented
- GitHub Actions Setup — Configure GitHub Actions
- GitHub Actions Verification — Verify CI/CD setup

Release & Images

Release Process — How to create releases
GitHub Workflow Images — Docker images on GitHub Container Registry

🛠️ Troubleshooting

Common Issues

Docker Startup Troubleshooting — Docker won't start
Database Connection Issues — Can't connect to database
PDF Generation Issues — PDFs not generating
Solution Guide — General problem solving

Quick Fixes

Port conflicts: Change PORT=8081 in docker-compose command
Database issues: Run docker-compose down -v && docker-compose up -d
Permission errors: Check file ownership with chown -R $USER:$USER .
Migration failures: See Database Migrations

📚 Additional Resources

Features & Improvements

Detailed documentation about features and improvements is available in:

Implementation Notes — Development summaries and changelogs
Feature Guides — Specific feature documentation

Implementation Notes

Recent improvements and changes:

Feature Specific

Feature documentation and quick starts:

🔍 Documentation by Topic

For New Users

Start with Main README for product overview
Review Requirements to check if your system is compatible
Follow Docker Public Setup for installation
Explore Feature Documentation to learn what TimeTracker can do

For Developers

Read Contributing Guidelines before making changes
Review Project Structure to understand the codebase
Check Solution Guide for technical patterns
Use Local Testing with SQLite for development

For Administrators

Follow Docker Public Setup for deployment
Review Version Management for updates
Set up Database Migrations for schema management
Configure CI/CD for automated deployments

For Troubleshooting

Check Docker Startup Troubleshooting
Review Database Connection Issues
Consult Solution Guide for common problems
Check specific feature documentation if issue is feature-related

📝 Documentation Structure

docs/
├── README.md                          # This file - documentation index
├── REQUIREMENTS.md                    # System requirements
├── PROJECT_STRUCTURE.md               # Codebase architecture
├── CONTRIBUTING.md                    # Contribution guidelines
├── CODE_OF_CONDUCT.md                 # Community standards
│
├── cicd/                              # CI/CD documentation
│   ├── CI_CD_DOCUMENTATION.md
│   ├── CI_CD_QUICK_START.md
│   └── ...
│
├── features/                          # Feature-specific guides
│   ├── ALEMBIC_MIGRATION_README.md
│   ├── PROJECT_COSTS_FEATURE.md
│   └── ...
│
└── implementation-notes/              # Development notes
    ├── ANALYTICS_IMPROVEMENTS_SUMMARY.md
    ├── UI_IMPROVEMENTS_SUMMARY.md
    └── ...

🤝 Contributing to Documentation

Found an error? Want to improve the docs?

Check the Contributing Guidelines
Make your changes to the relevant documentation file
Test that all links work correctly
Submit a pull request with a clear description

Good documentation helps everyone! 📚

💡 Tips for Using This Documentation

Use the search function in your browser (Ctrl/Cmd + F) to find specific topics
Follow links to related documentation for deeper understanding
Start with Quick Links at the top if you're in a hurry
Browse by topic using the categorized sections
Check Implementation Notes for recent changes and improvements

Need help? Open an issue or check the troubleshooting section

Want to contribute? See our Contributing Guidelines

⬆ Back to Top