Objective

Add a workflow to automatically check for broken links in all markdown documentation files, preventing dead links from accumulating.

Context

The repository has extensive documentation spread across multiple files. Broken links can:

• Frustrate users trying to find information
• Create poor user experience
• Reference outdated or moved resources

No automated link checking currently exists.

Approach

1. Create .github/workflows/link-check.yml workflow
2. Use lychee-action or markdown-link-check action
3. Configure to check all .md files in the repository
4. Add configuration file to exclude known unavailable URLs (e.g., localhost, example.com)
5. Run on PR and scheduled weekly

Files to Create

• Create: .github/workflows/link-check.yml
• Create: .github/lychee.toml or .github/markdown-link-check.json (configuration)

Acceptance Criteria

• Workflow checks all markdown files for broken links
• Workflow runs on pull requests and weekly schedule
• Configuration excludes expected unavailable URLs
• All current documentation has valid links (or violations are fixed)
• Workflow provides clear failure messages when links are broken

References

• lychee action: https://github.com/lycheeverse/lychee-action
• markdown-link-check: https://github.com/gaurav-nelson/github-action-markdown-link-check
  Related to [plan] improve ci/cd pipeline and quality gates #348

AI generated by Plan Command for discussion #345