What problem does it solve?
Ensuring that plugin documentation is complete, accurate, and compliant with marketplace standards is a manual and error-prone process. This skill automates the validation of various documentation components, including READMEs, licenses, changelogs, and examples, ensuring high-quality and consistent documentation, saving you time and improving user experience.
Core Features & Use Cases
- README & License Check: Verifies the presence and content of
README.md and license files, ensuring legal and informational compliance.
- Changelog & Example Validation: Ensures changelogs are well-formatted and examples are functional and up-to-date.
- Full Documentation Audit: Performs a comprehensive check of all documentation aspects, providing a holistic view of its quality.
- Use Case: A plugin developer wants to ensure their documentation is ready for marketplace submission. They use this skill to run a full documentation validation, which checks for a valid license, a well-structured README, and up-to-date examples, providing a report on any missing or incorrect elements and preventing submission rejections.
Quick Start
Use the documentation-validation skill to check the README file for the plugin at "plugins/my-plugin".
