Skip to content

fix(ci): enable anchor link validation in scheduled link checker#4604

Open
jsklan wants to merge 3 commits intomainfrom
jsklan/fix-broken-overrides-link
Open

fix(ci): enable anchor link validation in scheduled link checker#4604
jsklan wants to merge 3 commits intomainfrom
jsklan/fix-broken-overrides-link

Conversation

@jsklan
Copy link
Copy Markdown
Contributor

@jsklan jsklan commented Mar 27, 2026

Description

Fixes a broken same-page anchor link in the overrides docs page, and updates the scheduled link checker to catch this class of bug going forward.

The link [multiple override files](#multiple-override-files) pointed to a heading that doesn't exist — the correct anchor is #managing-overrides-across-apis. The scheduled check-links.yml workflow didn't catch this because it explicitly excluded anchor-only links (^#) and didn't validate HTML fragment targets.

Context: The ^# exclusion and lack of --include-fragments were part of the original lychee setup in #2581, likely to avoid noise from fragments that couldn't be validated via HTTP. With --include-fragments, lychee now fetches each page and verifies that anchor targets exist as id attributes in the rendered HTML.

Changes Made

  • overrides.mdx: Fix broken anchor #multiple-override-files#managing-overrides-across-apis
  • check-links.yml: Remove ^# exclusion so anchor links are no longer skipped
  • check-links.yml: Add --include-fragments flag so lychee validates that anchor targets actually exist in rendered pages

Testing

  • Trigger check-links.yml manually via workflow_dispatch to verify anchor validation works
  • Confirm no false positives from the new fragment checking

@jsklan jsklan requested a review from devalog as a code owner March 27, 2026 19:59
@github-actions
Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://fern-preview-jsklan-fix-broken-overrides-link.docs.buildwithfern.com/learn

Here are the markdown pages you've updated:

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 1 additional finding.

Open in Devin Review

@jsklan jsklan changed the title Jsklan/fix broken overrides link fix(ci): enable anchor link validation in scheduled link checker Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant