upskill-event-manager/docs/README.md
bengizmo 40274d98ad feat: Implement comprehensive user role field and certification tracking system
• Add user role field to registration, profile display, and profile edit
  - 10 role options: technician, installer, supervisor, manager, trainer, consultant, sales rep, engineer, business owner, other
  - Required field with server-side validation
  - Radio buttons in registration, dropdown in profile edit
  - Displays in profile with proper capitalization

• Implement advanced certification tracking system
  - Date Certified: HTML5 date picker with validation (no future dates)
  - Certification Type: dropdown with "Certified measureQuick Trainer" and "Certified measureQuick Champion"
  - Certification Status: color-coded status badges (Active/Expired/Pending/Disabled)

• Add sophisticated role-based access control
  - Regular trainers: read-only access to certification fields
  - Administrators & master trainers: full edit access to certification fields
  - Visual indicators for read-only fields
  - Server-side permission validation

• Enhance plugin activation system
  - Initialize all 36 user meta fields for existing users
  - Smart default assignment based on user capabilities
  - Backward compatibility maintained

• Add professional UI styling
  - Blue-bordered certification section with trophy icon
  - Color-coded status badges with proper contrast
  - Read-only field styling with visual indicators
  - Enhanced form controls with focus states

• Comprehensive testing and documentation
  - E2E test coverage with visual verification
  - Updated API reference with new meta fields
  - Access control patterns documented
  - 100% test pass rate on staging environment

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-01 10:52:11 -03:00

3 KiB

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

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

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

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

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
  2. Review error logs in /wp-content/debug.log
  3. Contact development team with detailed error information

Version History

  • v2.0.0 (Current) - Major refactor with modular architecture
  • v1.0.0 - Initial release

Last updated: August 2025