Update AI assistant documentation for wiki management

This commit is contained in:
2025-04-17 04:12:01 +01:00
parent 0c194d9e23
commit 9afa732c20
5 changed files with 186 additions and 3 deletions

@@ -23,6 +23,7 @@ Detailed workflow documentation is available in the `.ai-workflows/` directory:
- **@.ai-workflows/incremental-development.md**: Time-efficient approach for incremental development and testing
- **@.ai-workflows/local-env-vars.md**: Local development environment paths and URLs
- **@.ai-workflows/release-process.md**: Steps for preparing and publishing releases
- **@.ai-workflows/wiki-documentation.md**: Guidelines for maintaining wiki documentation
## Version Management
@@ -108,6 +109,21 @@ AI assistants should maintain a record of developer preferences in **@.ai-workfl
This ensures consistency across coding sessions and reduces the need for developers to repeatedly explain their preferences.
## Wiki Documentation
The plugin has a GitHub wiki that is automatically synced from the `.wiki` directory in the repository. When making changes to the codebase, it's important to keep the wiki documentation up-to-date.
### Key Principles
- **Documentation Synchronization**: Ensure that README.md, readme.txt, and wiki documentation are kept in sync
- **Feature Documentation**: Document new features, hooks, and filters in all relevant places
- **Code Structure Documentation**: Update technical documentation when changing code structure
- **Automatic Syncing**: Changes to the `.wiki` directory are automatically synced to the GitHub wiki
For detailed guidelines on maintaining wiki documentation, see **@.ai-workflows/wiki-documentation.md**.
**IMPORTANT**: When updating features, functions, hooks, or code structure, always check if the wiki documentation needs to be updated as well. This ensures that users have access to accurate and up-to-date information.
## Common Tasks
For detailed instructions on common tasks like creating releases, adding features, fixing bugs, and testing previous versions, see **@.ai-workflows/release-process.md**.