17de1949ae
- folder-structure.md: fix includes/core.php → Core.php, plugin.php → Plugin.php, updater.php → Updater.php (PascalCase matches actual filenames on disk) - bug-fixing.md: fix fix-plugin-does-not-exist-notices.php → wp-fix-plugin-does-not-exist-notices.php (correct wp- prefix) and languages/fix-plugin... → languages/wp-fix-plugin... (same prefix fix) - feature-development.md: remove reference to non-existent reference-plugins/ directory to stop read:file_not_found errors when AI follows the docs Addresses contributor insight issue #16: incorrect file paths in AI workflow docs were the root cause of 23x read:file_not_found, 71x edit:not_read_first, 32x edit:edit_stale_read, and 66x bash:other errors in AI assistant sessions.
2.6 KiB
2.6 KiB
Folder Structure
This document outlines the folder structure of the plugin and explains the purpose of each directory.
Root Directories
- admin/ - Contains admin-specific functionality and assets
- includes/ - Contains core plugin functionality and classes
- languages/ - Contains translation files
- scripts/ - Contains build and deployment scripts
- .ai-workflows/ - Contains documentation for AI assistants
- .github/ - Contains GitHub-specific files like workflows
- .wordpress-org/ - Contains WordPress.org assets like banners and screenshots
Admin Directory Structure
- admin/css/ - Admin-specific CSS files
- admin/js/ - Admin-specific JavaScript files
- admin/images/ - Admin-specific images
- admin/partials/ - Admin-specific template partials
- admin/settings/ - Admin settings functionality
- admin/tools/ - Admin tools functionality
- admin/lib/ - Admin-specific library files and helper functions
- admin/lib/admin.php - Admin class for handling admin-specific functionality
- admin/lib/modal.php - Modal class for handling the update source selector modal
Includes Directory
The includes/ directory contains the core plugin functionality:
- includes/Core.php - Core class for handling the main plugin functionality
- includes/Plugin.php - Main plugin class that initializes all components
- includes/Updater.php - Updater class for handling plugin updates
File Naming Conventions
- All PHP files in the
includes/directory use lowercase filenames - All directories use lowercase names
- JavaScript and CSS files use kebab-case (e.g.,
update-source-selector.js)
Best Practices
- Unique Directory Names: Each directory should have a unique name to avoid confusion
- Logical Organization: Files should be organized logically by function
- Consistent Naming: File and directory names should follow consistent naming conventions
- Clear Separation: Admin functionality should be separate from core functionality
- Minimal Dependencies: Files should have minimal dependencies on other files
@mentions for AI Assistants
When referring to files or directories in AI conversations, use the following format:
- @includes/Plugin.php - Main plugin class
- @includes/Core.php - Core functionality
- @admin/lib/admin.php - Admin functionality
- @admin/lib/modal.php - Modal functionality
- @includes/Updater.php - Updater functionality
- @admin/js/update-source-selector.js - Update source selector JavaScript
- @admin/css/update-source-selector.css - Update source selector CSS