Skip to content

ci: skip GitHub edit URLs in link checker - #166

Draft
claude[bot] wants to merge 1 commit into
mainfrom
fix/skip-github-edit-links-in-linkcheck
Draft

ci: skip GitHub edit URLs in link checker#166
claude[bot] wants to merge 1 commit into
mainfrom
fix/skip-github-edit-links-in-linkcheck

Conversation

@claude

@claude claude Bot commented Aug 4, 2026

Copy link
Copy Markdown

Requested by William · Slack thread

  • What: The docs link checker was reporting the "Edit on GitHub" link as a broken link (502). It isn't broken — GitHub's /edit/ URLs are auth-gated and return 502 to unauthenticated crawlers. This adds a --skip so linkinator no longer follows those edit URLs.
  • Why: linkinator runs with -r, so it recursively crawls the edit link that Vocs renders on every page. Its status filter excludes 403/429/0/304 but not 502, so the edit URL slipped through as "BROKEN" and got posted to the Slack alert. The edit link itself (Vocs editLink in vocs.config.tsx) is a legitimate, working feature for logged-in contributors — the fix is checker-side, not removing the link.
  • How: One --skip "github\.com\/pimlicolabs\/docs\/edit" flag added to the existing linkinator invocation in .github/workflows/check-links.yaml, matching the three --skip flags already there.

Generated by Claude Code

The Vocs "Edit on GitHub" link renders on every page and points to
github.com/.../edit/..., which is auth-gated and returns 502 to the
unauthenticated linkinator crawler. That false positive was being
reported as a broken link. Skip the edit URL so the checker no longer
crawls it.
@vercel

vercel Bot commented Aug 4, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 4, 2026 1:54pm

Request Review

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