-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Open
Labels
Description
Description
Implement automated scanning to detect 404 errors and broken links across the Coder documentation. This should include:
- Automated 404 detection: A check that scans the documentation site for pages that return 404 errors
- Broken link scanning: Proactively scan internal and external links to identify broken references before they impact users
- Page render validation: Verify that linked pages render appropriately and contain expected content
- Notification system: Alert the team when 404s or broken links are detected
The solution should run on a regular schedule (e.g., daily) and ideally integrate into the CI/CD pipeline to catch issues before deployment.
Impact
Users encounter 404 errors when navigating documentation links, leading to frustration and inability to access critical information. This undermines confidence in the documentation and creates support burden. Proactive scanning would catch these issues before they reach users.
Links
- Slack thread: https://coder.slack.com/archives/C068RSN2F6K/p1764773937194579
- Related closed issue: Links to Documentation in the Latest Version of Coder are Broken #14945