marcusquinn
0e6f9639f4
Some checks failed
Tests / PHP 7.0 (push) Has been cancelled
Tests / PHP 7.4 (push) Has been cancelled
Tests / PHP 8.0 (push) Has been cancelled
Tests / Code Style (push) Has been cancelled
Release / Build and Release (push) Has been cancelled
Sync Wiki / Sync Wiki to GitHub (push) Has been cancelled
42 lines
2.3 KiB
Markdown
42 lines
2.3 KiB
Markdown
# WordPress Plugin Starter Template
|
|
|
|
Welcome to the documentation wiki for the WordPress Plugin Starter Template.
|
|
|
|
This template provides a solid foundation for developing WordPress plugins with best practices for AI-assisted development.
|
|
|
|
## Quick Links
|
|
|
|
- [Starter Prompt](Starter-Prompt)
|
|
- [Installation Guide](Installation-Guide)
|
|
- [Usage Instructions](Usage-Instructions)
|
|
- [Frequently Asked Questions](Frequently-Asked-Questions)
|
|
- [Contributing](Contributing)
|
|
- [Changelog](Changelog)
|
|
|
|
## About This Template
|
|
|
|
The WordPress Plugin Starter Template is designed to help developers quickly create new WordPress plugins with a solid foundation of best practices. It incorporates modern coding standards, comprehensive documentation, and AI-assisted development workflows.
|
|
|
|
This template is based on the experience gained from developing the "Fix 'Plugin file does not exist' Notices" plugin and other successful WordPress plugins.
|
|
|
|
## Key Features
|
|
|
|
- **Object-Oriented Architecture**: Well-structured, maintainable code using OOP principles
|
|
- **Namespace Support**: Modern PHP namespacing for better organization and avoiding conflicts
|
|
- **Comprehensive Documentation**: Detailed documentation for both users and developers
|
|
- **Testing Framework**: PHPUnit setup for unit testing
|
|
- **Internationalization Ready**: Full support for translation and localization
|
|
- **Update Source Selection**: Choose between WordPress.org, GitHub, or Gitea for plugin updates
|
|
- **AI Workflow Documentation**: Detailed guides for AI-assisted development
|
|
- **Wiki Documentation**: Ready-to-use wiki structure for comprehensive documentation
|
|
|
|
## Getting Started
|
|
|
|
To get started with this template, check out the [Starter Prompt](Starter-Prompt) for a comprehensive guide on customizing the template for your specific plugin needs.
|
|
|
|
**Important**: For the best AI assistance, add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context. In most AI IDEs, you can pin these files to ensure they're considered in each message.
|
|
|
|
## Support
|
|
|
|
If you encounter any issues or have questions about the template, please check the [Frequently Asked Questions](Frequently-Asked-Questions) section. If you still need help, you can [open an issue](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/issues) on GitHub.
|