ci: dartdoc_options ignores the broken-link category

The dart-doc gate (test.yml) should fail on real doc-comment defects
(unresolved [symbol] references — kept strict), not on dartdoc rendering
artifacts. clide is an app, not a published library: its README landing-page
relative links and the generated 1512-glyph Phosphor icon font produce broken
cross-links with no fixable cause. Ignore the broken-link category; verified
`dart doc --validate-links` now emits zero warnings.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-06-14 22:14:43 +02:00
co-authored by Claude Opus 4.8
parent c08f249b00
commit ba02727c5e
+17
View File
@@ -0,0 +1,17 @@
# dartdoc configuration.
#
# clide is an application, not a published library — its lib/ API docs are not
# a consumed surface. The dart-doc CI gate (.github/workflows/test.yml) exists
# to catch real doc-comment defects: unresolved [symbol] references. That check
# stays strict (unresolved-doc-reference is NOT ignored).
#
# The "broken-link" category, by contrast, is pure rendering noise here:
# - The README is dartdoc's landing page; its repo-relative links
# ([CLAUDE.md], [docs/…], [LICENSE]) are correct on GitHub but don't resolve
# once copied into the generated API site.
# - The generated Phosphor icon font (lib/widgets/src/icons/phosphor_glyphs.g.dart,
# 1512 glyphs) produces broken cross-links to its own library page.
# Neither is a fixable doc-quality problem, so the category is ignored.
dartdoc:
ignore:
- broken-link