Dart Doc Validation

What it does

This skill validates Dart documentation using the dart doc command. It checks for common errors and warnings in your Dart code's documentation, ensuring that generated API references are accurate and complete. The validation process helps maintain a high standard of code quality and developer experience.

When to use it

• Before publishing a Dart package: Ensure your API documentation is correct before releasing your library or application.
• During code reviews: Quickly identify documentation issues during the review process.
• As part of CI/CD pipelines: Automate documentation validation as part of your continuous integration and deployment workflow.
• When refactoring Dart code: Verify that changes to your codebase haven't introduced any documentation errors.

Key capabilities

• Runs dart doc command-line tool.
• Checks for common documentation warnings and errors.
• Provides feedback on the quality of Dart API documentation.

Example prompts

• "Validate the documentation in this directory: /path/to/my/dart/project."
• "Run dartdoc validation and report any errors."
• "Check my Dart package's documentation for completeness."

Tips & gotchas

• Requires a working Dart SDK to be installed on the system.
• The skill’s output will depend on the complexity of your project's documentation.