Add a script to detect broken links in Markdown documentation

[Abhijais4896]

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

[harshitsaxena214]

I want to work on this issue

[bupd]

tbh - this is a really hard problem - a script wouldnt fix it. and it would fail in most cases - since for eg - github links still serve content when requested but the problem is they would still serve a webpage and that webpage is changed depending on the service the status codes are really different - some even give 200 and show the 404 page & some even have 404 page as an image. this would be really hard scripting this.

[Abhijais4896]

Agree @bupd