upskill-event-manager/docs/README.md
bengizmo 55d0ffe207 feat: Implement comprehensive trainer profile custom post type system
This commit implements a complete trainer profile custom post type system with the following components:

## Core Features Implemented:
- Custom post type 'trainer_profile' with full CRUD operations
- Bidirectional data synchronization between wp_users and trainer profiles
- Google Maps API integration for geocoding trainer locations
- Master trainer interface for profile management
- Data migration system for existing users

## Key Components:
1. **HVAC_Trainer_Profile_Manager**: Core profile management with singleton pattern
2. **HVAC_Profile_Sync_Handler**: Bidirectional user-profile data synchronization
3. **HVAC_Geocoding_Service**: Google Maps API integration with rate limiting
4. **HVAC_Trainer_Profile_Settings**: Admin configuration interface
5. **Migration System**: Comprehensive user meta to custom post migration

## Templates & UI:
- Enhanced trainer profile view with comprehensive data display
- Full-featured profile edit form with 58+ fields
- Master trainer profile editing interface
- Professional styling and responsive design
- Certificate pages template integration fixes

## Database & Data:
- Custom post type registration with proper capabilities
- Meta field synchronization between users and profiles
- Migration of 53 existing trainers to new system
- Geocoding integration with coordinate storage

## Testing & Deployment:
- Successfully deployed to staging environment
- Executed data migration for all existing users
- Comprehensive E2E testing with 85-90% success rate
- Google Maps API configured and operational

## System Status:
 Trainer profile viewing and editing: 100% functional
 Data migration: 53 profiles created successfully
 Master dashboard integration: Clickable trainer names working
 Certificate pages: Template integration resolved
 Geocoding: Google Maps API configured and enabled
⚠️ Master trainer profile editing: Minor template issue remaining

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-01 18:45:41 -03:00

116 lines
No EOL
4.3 KiB
Markdown

# HVAC Community Events Plugin Documentation
## Overview
The HVAC Community Events plugin is a comprehensive event management system designed specifically for HVAC trainers. It integrates seamlessly with WordPress and The Events Calendar to provide trainer profiles, certificate generation, venue management, certification tracking, and advanced reporting capabilities.
## Documentation Structure
### 📋 [Configuration Guide](./CONFIGURATION.md)
Complete reference for plugin configuration including:
- System architecture overview
- Configuration files and constants
- User roles and permissions
- URL structure and routing
- Theme integration (Astra)
- Database structure
### 💻 [Development Guide](./DEVELOPMENT-GUIDE.md)
Best practices and guidelines for developers:
- Development environment setup
- Coding standards (WordPress, PHP, JS, CSS)
- Architecture principles and patterns
- Git workflow and deployment process
- Testing strategies
- Security best practices
- Performance optimization
### 🔧 [Troubleshooting Guide](./TROUBLESHOOTING.md)
Solutions to common issues:
- 404 errors and missing pages
- Navigation and menu problems
- CSS and theme conflicts
- Database issues
- Performance problems
- Recovery procedures
- Debugging techniques
### 🏗️ [Architecture Documentation](./ARCHITECTURE.md)
Technical architecture details:
- Plugin structure
- Class responsibilities
- Hook system
- Data flow
- Integration points
## Quick Start
### Installation
1. Upload plugin to `/wp-content/plugins/`
2. Activate through WordPress admin
3. Plugin automatically creates required pages
4. Configure settings as needed
### Key Features
- **Trainer Profiles**: Comprehensive trainer management with photos, certifications, and statistics
- **Event Management**: Full integration with The Events Calendar
- **Certificate Generation**: Automated PDF certificate creation with custom templates
- **Venue Management**: Organize training locations with TEC integration
- **Master Dashboard**: Aggregate reporting for master trainers
- **Hierarchical URLs**: SEO-friendly URL structure (`/trainer/dashboard/`)
### User Roles
1. **hvac_trainer**: Standard trainer role
- Manage own events
- Generate certificates
- Manage profile, venues, organizers
2. **hvac_master_trainer**: Advanced trainer role
- All trainer capabilities
- View aggregate reports
- Access master dashboard
- Manage other trainers
### Important Notes
- **Dual-role users** (both trainer and master trainer) will only see the master trainer navigation
- Plugin requires **The Events Calendar** to be installed and active
- Optimized for **Astra theme** but compatible with most WordPress themes
- PHP 7.4+ required (PHP 8.0+ recommended)
## Support
For issues or questions:
1. Check the [Troubleshooting Guide](./TROUBLESHOOTING.md)
2. Review error logs in `/wp-content/debug.log`
3. Contact development team with detailed error information
## Recent Fixes & Updates
### Certificate Pages Template System (August 1, 2025) ✅
**Fixed critical template loading issue affecting certificate pages**
- **Problem**: Certificate pages (`/trainer/certificate-reports/`, `/trainer/generate-certificates/`) were bypassing WordPress template system, showing bare shortcode content without theme headers, navigation, or styling
- **Root Cause**: `load_custom_templates()` method loading content-only templates instead of proper page templates
- **Solution**: Updated template paths to use full page templates with proper WordPress integration
- **Additional Fixes**:
- Eliminated duplicate breadcrumbs by disabling Astra theme breadcrumbs on plugin pages
- Restored missing navigation menu by removing problematic constant checks
- **Result**: Certificate pages now display with complete theme integration, proper headers/footers, navigation, and consistent styling
### Previous Major Updates
- **Navigation and Layout System** (August 1, 2025) - Dual-role user navigation, sidebar removal, profile page templates
- **Role and Certification System** (August 1, 2025) - Comprehensive user roles and certification tracking with 10 role options
- **Major Plugin Refactor** (July 30, 2025) - Registration system overhaul, new trainer pages, comprehensive navigation system
## Version History
- **v2.0.0** (Current) - Major refactor with modular architecture
- **v1.0.0** - Initial release
---
Last updated: August 2025