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

Fix wiki navigation, update wiki changelog, improve documentation, and fix tests workflow

Browse Source
This commit is contained in:
Marcus Quinn
2025-04-18 15:05:49 +01:00
parent 5083fcee50
commit af48e84614
6 changed files with 68 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
.ai-workflows/release-process.md
View File

@@ -150,7 +150,15 @@ If the plugin is hosted on WordPress.org:
After releasing a new version:
1. Update the wiki documentation if needed
2. Announce the release in relevant channels
3. Monitor for any issues or feedback
4. Start planning the next release
1. Update the wiki documentation:
- Update the Changelog.md file in the .wiki directory to match the main CHANGELOG.md
- Add the new version information to the Home.md file in the Latest Updates section
- Ensure all wiki pages are up-to-date with the new features or changes
- Verify that the _Sidebar.md file has the correct navigation structure
2. Verify that GitHub Actions workflows are running correctly:
- Check that the release workflow created the release with the correct assets
- Check that the sync-wiki workflow synced the wiki changes
- Fix any permissions issues in the workflow files if needed
3. Announce the release in relevant channels
4. Monitor for any issues or feedback
5. Start planning the next release

7
.ai-workflows/wiki-documentation.md
View File

@@ -8,6 +8,7 @@ The wiki documentation is organized into the following sections:
1. **User Documentation**:
- Home
- Starter Prompt (must be listed before Installation Guide)
- Installation Guide
- Usage Instructions
- Frequently Asked Questions
@@ -88,8 +89,10 @@ Documentation should be updated:
1. Identify the relevant wiki file(s) in the `.wiki/` directory
2. Make the necessary changes
3. Commit and push the changes to the `main` branch
4. The GitHub Actions workflow will automatically sync the changes with the GitHub wiki
3. **Always ensure the Changelog.md in the wiki is updated to match the main CHANGELOG.md file**
4. **Always ensure the _Sidebar.md file has the correct navigation structure with Starter Prompt listed before Installation Guide**
5. Commit and push the changes to the `main` branch
6. The GitHub Actions workflow will automatically sync the changes with the GitHub wiki
### Creating New Pages