dart-doc-validation

Validate Dart documentation comments for unresolved references and undefined macros.

3|Updated Dec 23, 2025
One-click install
npx skills add https://github.com/boazcstrike/opencode --skill dart-doc-validation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dart-doc-validation
Source: https://github.com/boazcstrike/opencode/tree/main/skills/dart-doc-validation
Command: npx skills add https://github.com/boazcstrike/opencode --skill dart-doc-validation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps ensure the quality and correctness of documentation comments in Dart code, preventing broken links and unresolved references that can confuse users and hinder package publishing.

Core Features & Use Cases

  • Detects unresolved references: Identifies links to identifiers that do not exist in the codebase or imported libraries.
  • Catches undefined macros: Flags usage of documentation macros that have not been defined.
  • Validates for pub.dev: Ensures documentation is clean and ready for publishing to the Dart package repository.

Quick Start

Validate the documentation comments in the current Dart project.

Frequently Asked Questions about dart-doc-validation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate Dart documentation comments for unresolved references?

You can validate Dart documentation comments by running the `dart doc` command locally, which identifies links to identifiers that do not exist in the codebase or imported libraries and ensures documentation correctness.

What causes undefined macros in Dart documentation?

Undefined macros in Dart documentation occur when documentation comments reference macros that have not been defined in the codebase, which validation tools flag to prevent broken documentation generation.

Do I need the Dart SDK to check documentation comments for pub.dev publishing?

Yes, you need the Dart SDK installed to execute the `dart doc` command for local validation, ensuring your documentation is clean and ready for publishing to the Dart package repository.

How do I prevent broken links in Dart package documentation?

Prevent broken links in Dart package documentation by validating comments to detect unresolved references and undefined macros, ensuring adherence to best practices for documentation generation and package publishing.

Can I check Dart documentation readiness before publishing to pub.dev?

Yes, you can check documentation readiness before publishing to pub.dev by validating comments locally, ensuring they are free of unresolved references and undefined macros for a clean package release.