Skip to content

Add automated 404 detection and broken link scanning for documentation #21163

@coder-doc-bot

Description

@coder-doc-bot

Description

Implement automated scanning to detect 404 errors and broken links across the Coder documentation. This should include:

  1. Automated 404 detection: A check that scans the documentation site for pages that return 404 errors
  2. Broken link scanning: Proactively scan internal and external links to identify broken references before they impact users
  3. Page render validation: Verify that linked pages render appropriately and contain expected content
  4. 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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions