wpallstars/wp-plugin-starter-template-for-ai-coding
Template
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename .ai-assistant.md to AGENTS.md and .ai-workflows to .agents

Browse Source
This commit is contained in:
Marcus Quinn
2025-11-24 00:16:56 +00:00
parent 136f07d9c4
commit 6300b687aa
29 changed files with 48 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.wiki/AI-Workflow-Documentation.md
View File

@@ -12,8 +12,8 @@ AI-assisted development uses artificial intelligence tools to help with coding,
To get the most out of AI-assisted development, make sure to include these files in your AI IDE context:
1. **.ai-assistant.md**: Contains essential information about the project structure and conventions
2. **.ai-workflows/**: Directory containing detailed workflow documentation for common tasks
1. **AGENTS.md**: Contains essential information about the project structure and conventions
2. **.agents/**: Directory containing detailed workflow documentation for common tasks
### Pinning Files in AI IDEs
@@ -26,7 +26,7 @@ For the best results, pin these files in your AI IDE chat context:
## AI Workflow Files
The `.ai-workflows/` directory contains detailed guides for common development tasks:
The `.agents/` directory contains detailed guides for common development tasks:
1. **plugin-customization.md**: Guide for customizing the plugin for specific needs
2. **feature-development.md**: Workflow for developing new features
@@ -50,7 +50,7 @@ The [Starter Prompt](Starter-Prompt) is a comprehensive guide for AI tools to he
### Customizing the Plugin
1. Open your AI IDE and pin the `.ai-assistant.md` file and `.ai-workflows/` directory
1. Open your AI IDE and pin the `AGENTS.md` file and `.agents/` directory
2. Provide the Starter Prompt to the AI
3. Follow the AI's guidance to customize the plugin
4. Review and test the changes

2
.wiki/Architecture-Overview.md
View File

@@ -25,7 +25,7 @@ wp-plugin-starter-template/
│ └── unit/ # Unit tests
├── .github/ # GitHub-specific files
│ └── workflows/ # GitHub Actions workflows
├── .ai-workflows/ # AI workflow documentation
├── .agents/ # AI workflow documentation
├── .wiki/ # Wiki documentation
└── wp-plugin-starter-template.php # Main plugin file
```

2
.wiki/Changelog.md
View File

@@ -25,7 +25,7 @@ This page documents all notable changes to the WordPress Plugin Starter Template
### Added
- Improved AI IDE context recommendations in documentation
- Enhanced Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/
- Enhanced Starter Prompt with guidance on pinning AGENTS.md and .agents/
### Changed

6
.wiki/Frequently-Asked-Questions.md
View File

@@ -80,8 +80,8 @@ To configure the update mechanism:
The template includes:
1. Detailed documentation in the `.ai-assistant.md` file
2. Workflow guidelines in the `.ai-workflows/` directory
1. Detailed documentation in the `AGENTS.md` file
2. Workflow guidelines in the `.agents/` directory
3. Clear code structure and comments that help AI understand the codebase
4. Best practices for AI-friendly code organization
@@ -96,7 +96,7 @@ This template is designed to work well with various AI coding assistants, includ
### How do I use the AI workflow documentation?
The AI workflow documentation in the `.ai-workflows/` directory provides guidelines for AI assistants working with this template. These files help ensure consistent, high-quality code and documentation when using AI tools for development.
The AI workflow documentation in the `.agents/` directory provides guidelines for AI assistants working with this template. These files help ensure consistent, high-quality code and documentation when using AI tools for development.
## Contributing Questions

2
.wiki/Home.md
View File

@@ -39,7 +39,7 @@ This template is based on the experience gained from developing the "Fix 'Plugin
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.
**Important**: For the best AI assistance, add the AGENTS.md file and .agents/ 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

10
.wiki/Starter-Prompt.md
View File

@@ -4,7 +4,7 @@ This document provides a comprehensive prompt to help you get started with creat
## Important: Optimize AI Context
**Before starting, 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. This will help the AI understand the project structure and follow the established best practices.
**Before starting, add the AGENTS.md file and .agents/ directory to your AI IDE chat context.** In most AI IDEs, you can pin these files to ensure they're considered in each message. This will help the AI understand the project structure and follow the established best practices.
## Initial Setup Prompt
@@ -35,7 +35,7 @@ I need help with the following tasks:
2. Customizing the plugin structure for my specific needs
3. Setting up the initial functionality for my plugin
I've added the .ai-assistant.md and .ai-workflows/ directory to the chat context to ensure you have all the necessary information about the project structure and best practices.
I've added the AGENTS.md and .agents/ directory to the chat context to ensure you have all the necessary information about the project structure and best practices.
Please guide me through this process step by step, starting with identifying all files that need to be updated with my plugin information.
```
@@ -52,7 +52,7 @@ The AI will help you identify and update the following files with your plugin in
6. **languages/pot file**: Rename and update the POT file
7. **.github/workflows/**: Update GitHub Actions workflows with your repository information
8. **.wiki/**: Update wiki documentation with your plugin information
9. **.ai-assistant.md**: Update AI assistant guidance for your specific plugin
9. **AGENTS.md**: Update AI assistant guidance for your specific plugin
10. **includes/plugin.php**: Update namespace and class references
11. **includes/core.php**: Update namespace and customize core functionality
12. **admin/lib/admin.php**: Update namespace and customize admin functionality
@@ -174,7 +174,7 @@ Please guide me through the process of building and testing my plugin:
To ensure the AI assistant has all the necessary context about your plugin's structure and best practices:
```
Please add the .ai-assistant.md 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. This will help the AI understand the project structure and follow the established best practices.
Please add the AGENTS.md and .agents/ directory to your AI IDE chat context. In most AI IDEs, you can pin these files to ensure they're considered in each message. This will help the AI understand the project structure and follow the established best practices.
```
## Remember
@@ -183,7 +183,7 @@ Please add the .ai-assistant.md and .ai-workflows/ directory to your AI IDE chat
- The AI assistant can help you understand the existing code and make appropriate modifications, but you should review all changes to ensure they meet your requirements.
- Always test your plugin thoroughly before releasing it.
- Keep documentation updated as you develop your plugin.
- Pin the .ai-assistant.md and .ai-workflows/ files in your AI IDE chat to ensure the AI has the necessary context for each interaction.
- Pin the AGENTS.md and .agents/ files in your AI IDE chat to ensure the AI has the necessary context for each interaction.
## Credits

2
.wiki/Usage-Instructions.md
View File

@@ -21,7 +21,7 @@ The template follows a modular structure:
- `js/`: Admin JavaScript files
- `languages/`: Translation files
- `.github/workflows/`: GitHub Actions workflows
- `.ai-workflows/`: Documentation for AI assistants
- `.agents/`: Documentation for AI assistants
- `.wiki/`: Wiki documentation templates
### Customizing for Your Plugin