Add daily broken link checker with Slack reporting

[eugenio-sanchez-sg]

Problem

We have internal links in our docs that point to pages that have been removed or renamed.

Solution

A GitHub Action that runs daily at 6am UTC, scans all docs for broken internal links, and reports the results to a Slack channel.

Implementation

New files:

• scripts/check-internal-links.js — Node script that:

  • Builds a set of valid routes from all MDX files
  • Extracts internal links from markdown [text](/path) and JSX href="/path" patterns
  • Skips code blocks to avoid false positives
  • Detects case mismatches (links that work on macOS but fail on Linux)
  • Reports to Slack via webhook (or prints locally if no webhook)

• .github/workflows/check-links.yml — Cron workflow that runs daily and sends results to Slack

Usage:

npm run check-internal-links  # Run locally (prints to console)

Setup required (after merge)

1. Create a Slack Incoming Webhook at api.slack.com/apps
2. Add SLACK_WEBHOOK_URL to GitHub repo Settings → Secrets → Actions

Open questions

• Is daily the right cadence, or would weekly be better?
• Which Slack channel should receive these reports?

Feedback welcome — this is a proposal to see if this approach makes sense for the team.

[vercel]

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

Project	Deployment	Review	Updated (UTC)
sourcegraph-docs	Ready	Preview, Comment	Jan 26, 2026 4:10pm