Skip to content

Check-mdx-links reports false positives for API links #209

@dobromirts

Description

@dobromirts

Check-mdx-links reports false positives for API links included here - #181

The check-mdx-links:report:* scripts (angular, react, wc, blazor) produce inaccurate results when validating API links inside MDX files. The link validation logic in check-mdx-links.mjs does not correctly resolve API link targets, leading to false positive broken-link reports.

image

After cross-checking the flagged links using the check-api-links:report:* scripts which crawl the actual built HTML output and validate links against real generated content, all reported links are confirmed to be valid.

image

Impact:

mdx-link-report-{platform}.md reports contain unreliable data for API links
False positives can block or mislead link remediation efforts

Steps to reproduce:
Run npm run check-mdx-links:report:angular (or any platform variant)
Note API links flagged as broken
Run npm run check-api-links:report:angular for the same platform
Observe that the same links resolve correctly against the built HTML
Expected behavior:
Either check-mdx-links should correctly validate API links, or its reports should explicitly exclude/disclaim API link results to avoid confusion.

Notes:

Verified locally - all API links are valid per the HTML-based crawler
The check-api-links scripts should be considered the authoritative source for API link validity

Metadata

Metadata

Assignees

Labels

✅ status: resolvedApplies to issues that have pending PRs resolving them, or PRs that have already merged.

Type

No fields configured for Bug.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions