kevmoo avatar

Dart Doc Validation

This one helps you catch broken doc comments before your Dart package goes live on pub.dev. It walks you through enabling the comment_references lint and running dart doc with a temp directory so you can validate without cluttering your workspace. The main insight here is using dart doc as a validation tool, not just a generator. You'll catch unresolved references and undefined macros that would otherwise slip through. It's straightforward advice, nothing fancy, but if you've ever published a package and realized your docs were full of dead links, you'll appreciate the prevention step.

skills.sh installs
291
GitHub stars
148
last updated
Aug 21, 2026

Install

$ npx -y skills add kevmoo/dash_skills --skill dart-doc-validation --agent claude-code

Installs into .claude/skills of the current project.

Files

Dart Doc Validation

1. When to use this skill

Use this skill when:

  • Writing or updating documentation comments (///) in Dart code.
  • Checking for broken documentation links, references, or macros.
  • Preparing a package for publishing to pub.dev.

When NOT to use (Abstention Guardrails)

Do NOT apply this skill or refactor doc comments when:

  • Illustrative Pseudo-Code & Non-Dart Code Fences: Comments contain pseudo-code, non-Dart language identifiers (e.g. yaml`, json, ````bash, ````text`), or abstract conceptual fragments intentionally not designed to compile as valid Dart.
  • Generated Code: Files generated by tools (e.g. *.g.dart, *.mocks.dart, *.freezed.dart) where comments are synthesized.
  • External Markdown Hyperlinks: Text in square brackets followed by a link target (e.g. [External Guide](https://...)), which is standard Markdown hyperlink syntax rather than an unresolved Dart doc reference.

Discovery

To find documentation issues:

Missing Lint

Verify if the comment_references lint is enabled:

  • Target: analysis_options.yaml
  • Search Query: comment_references

Automated Validation

Sponsors

Details

Repository
github.com/kevmoo/dash_skills
Category
Documentation
First seen
Jun 3, 2026

More from kevmoo/dash_skills

All 8
1davila7 avatarrailway-docsdavila7/claude-code-templatesFetch up-to-date Railway documentation to answer questions accurately. Use when user asks about Railway features, how Railway works, or shares a docs.railway.co284skills.sh installs
2longbridge avatargpui-style-guidelongbridge/gpui-componentGPUI Component project style guide based on gpui-component code patterns. Use when writing new components, reviewing code, or ensuring consistency with existing231skills.sh installs
3vincentkoc avatartechnical-documentationvincentkoc/dotskillsBuild and review high-quality technical docs as well as agent instruction files in your repository.231skills.sh installs
4warpdotdev avatardocs-updatewarpdotdev/oz-skillsUpdate user-facing documentation when code changes. Use when asked to update docs, review docs, handle documentation changes, run scheduled documentation tasks,206skills.sh installs
5get-convex avatarcomponents-guideget-convex/convex-agent-pluginsGuide to using Convex components for feature encapsulation. Learn about sibling components, creating your own, and when to use components vs monolithic code.196skills.sh installs
6sidkh avatarexplain-codesidkh/skillsExplain code as a scannable blog post171skills.sh installs