mirror of https://github.com/DRYTRIX/TimeTracker.git synced 2026-01-20 03:20:25 -06:00

Files

Dries Peeters 29f7186ee8 docs: Reorganize documentation structure for better navigation

Complete reorganization of project documentation to improve discoverability,
navigation, and maintainability. All documentation has been restructured into
a clear, role-based hierarchy.

## Major Changes

### New Directory Structure
- Created `docs/api/` for API documentation
- Created `docs/admin/` with subdirectories:
  - `admin/configuration/` - Configuration guides
  - `admin/deployment/` - Deployment guides
  - `admin/security/` - Security documentation
  - `admin/monitoring/` - Monitoring and analytics
- Created `docs/development/` for developer documentation
- Created `docs/guides/` for user-facing guides
- Created `docs/reports/` for analysis reports and summaries
- Created `docs/changelog/` for detailed changelog entries (ready for future use)

### File Organization

#### Moved from Root Directory (40+ files)
- Implementation notes → `docs/implementation-notes/`
- Test reports → `docs/testing/`
- Analysis reports → `docs/reports/`
- User guides → `docs/guides/`

#### Reorganized within docs/
- API documentation → `docs/api/`
- Administrator documentation → `docs/admin/` (with subdirectories)
- Developer documentation → `docs/development/`
- Security documentation → `docs/admin/security/`
- Telemetry documentation → `docs/admin/monitoring/`

### Documentation Updates

#### docs/README.md
- Complete rewrite with improved navigation
- Added visual documentation map
- Organized by role (Users, Administrators, Developers)
- Better categorization and quick links
- Updated all internal links to new structure

#### README.md (root)
- Updated all documentation links to reflect new structure
- Fixed 8 broken links

#### app/templates/main/help.html
- Enhanced "Where can I get additional help?" section
- Added links to new documentation structure
- Added documentation index link
- Added admin documentation link for administrators
- Improved footer with organized documentation links
- Added "Complete Documentation" section with role-based links

### New Index Files
- Created README.md files for all new directories:
  - `docs/api/README.md`
  - `docs/guides/README.md`
  - `docs/reports/README.md`
  - `docs/development/README.md`
  - `docs/admin/README.md`

### Cleanup
- Removed empty `docs/security/` directory (moved to `admin/security/`)
- Removed empty `docs/telemetry/` directory (moved to `admin/monitoring/`)
- Root directory now only contains: README.md, CHANGELOG.md, LICENSE

## Results

**Before:**
- 45+ markdown files cluttering root directory
- Documentation scattered across root and docs/
- Difficult to find relevant documentation
- No clear organization structure

**After:**
- 3 files in root directory (README, CHANGELOG, LICENSE)
- Clear directory structure organized by purpose and audience
- Easy navigation with role-based organization
- All documentation properly categorized
- Improved discoverability

## Benefits

1. Better Organization - Documentation grouped by purpose and audience
2. Easier Navigation - Role-based sections (Users, Admins, Developers)
3. Improved Discoverability - Clear structure with README files in each directory
4. Cleaner Root - Only essential files at project root
5. Maintainability - Easier to add and organize new documentation

## Files Changed

- 40+ files moved from root to appropriate docs/ subdirectories
- 15+ files reorganized within docs/
- 3 major documentation files updated (docs/README.md, README.md, help.html)
- 5 new README index files created
- 2 empty directories removed

All internal links have been updated to reflect the new structure.

2025-12-14 07:56:07 +01:00

1.9 KiB

Raw Blame History

Feature Implementation Progress

Date: 2025-01-27
Status: In Progress

✅ Completed Features

1. Offline Mode with Sync ✅

Files Created:

app/static/offline-sync.js - Complete offline sync manager with IndexedDB

Features:

✅ IndexedDB storage for time entries, tasks, projects
✅ Sync queue management
✅ Automatic sync when back online
✅ Conflict resolution support
✅ UI indicators for offline status
✅ Background sync via Service Worker

Next Steps:

Add offline support for tasks and projects
Enhance conflict resolution
Add UI for viewing pending sync items

2. Automation Workflow Engine ✅

Files Created:

app/models/workflow.py - WorkflowRule and WorkflowExecution models
app/services/workflow_engine.py - Complete workflow engine service
app/routes/workflows.py - Full CRUD routes for workflows
migrations/versions/069_add_workflow_automation.py - Database migration

Features:

✅ Rule-based automation system
✅ Multiple trigger types (task status, time logged, deadlines, etc.)
✅ Multiple action types (log time, send notification, update status, etc.)
✅ Template variable resolution ({{task.name}})
✅ Execution logging and history
✅ Priority-based rule execution
✅ REST API endpoints

Trigger Types Supported:

Task status changes
Task created/completed
Time logged
Deadline approaching
Budget threshold reached
Invoice created/paid

Action Types Supported:

Log time entry
Send notification
Update status
Assign task
Create task
Update project
Send email
Trigger webhook

Next Steps:

Create UI templates for workflow builder
Add workflow testing interface
Integrate workflow triggers into existing code

🚧 In Progress

3. Integrations

Starting with Google Calendar integration...

📋 Pending Features

See TODO list for remaining features.

1.9 KiB Raw Blame History