cncf / cncf/foundation

Add a script to detect broken links in Markdown documentation

Open
#1,331 3 comments 1 reaction 0 assignees View on GitHub
Dominant language
Rich Text Format
Stars
695
Forks
861
Avg merge
12h 19m
Merged PRs (30d)
23

Description

### Problem

The repository contains several Markdown documentation files such as:

- README.md
- docs/*.md
- examples documentation

Over time, some internal or external links in these files may become outdated or broken. This can negatively impact the user experience and make documentation less reliable.

Currently, broken links are typically detected manually during documentation reviews, which can be time-consuming and error-prone.

---

### Proposed Solution

Introduce a script that scans Markdown files in the repository and detects broken links automatically.

The script could:

- recursively scan Markdown files (`*.md`)
- extract all links from the files
- validate both internal and external links
- report links that return invalid HTTP status codes (e.g., 404, 500)

### Benefits

- Improves documentation reliability
- Helps contributors detect outdated links early
- Reduces manual review effort
- Improves overall documentation quality

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.