feat: add CI workflow to check for broken links (Lightning-AI#676)

* Fix Broken Link in README

* Added Markdown Link Checker Workflow

* update

* update

* Update .github/markdown-links-config.json

Co-authored-by: Bhimraj Yadav <bhimrajyadav977@gmail.com>

---------

Co-authored-by: Deependu <deependujha21@gmail.com>
Co-authored-by: Bhimraj Yadav <bhimrajyadav977@gmail.com>

Author: 3 people

.github/markdown-links-config.json

@@ -0,0 +1,27 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^https://github.com/Lightning-AI/litData/pull/"
+    },
+    {
+      "pattern": "^https://codecov.io/gh/Lightning-AI/litData/graph/badge.svg"
+    }
+  ],
+  "httpHeaders": [
+    {
+      "urls": [
+        "https://github.com/",
+        "https://guides.github.com/",
+        "https://help.github.com/",
+        "https://docs.github.com/"
+      ],
+      "headers": {
+        "Accept-Encoding": "zstd, br, gzip, deflate"
+      }
+    }
+  ],
+  "timeout": "20s",
+  "retryOn429": true,
+  "retryCount": 5,
+  "fallbackRetryDelay": "20s"
+}

.github/workflows/ci-checks.yml

@@ -37,3 +37,10 @@ jobs:
     uses: Lightning-AI/utilities/.github/workflows/check-docs.yml@main
     with:
       requirements-file: "requirements/docs.txt"
+
+  check-md-links:
+    uses: Lightning-AI/utilities/.github/workflows/check-md-links.yml@main
+    with:
+      config-file: ".github/markdown-links-config.json"
+      base-branch: "main"
+      force-check-all: "yes"

README.md

@@ -571,7 +571,7 @@ Stream data during long training, if interrupted, pick up right where you left o
 
 LitData provides a stateful `Streaming DataLoader` e.g. you can `pause` and `resume` your training whenever you want.
 
-Info: The `Streaming DataLoader` was used by [Lit-GPT](https://github.com/Lightning-AI/lit-gpt/blob/main/pretrain/tinyllama.py) to pretrain LLMs. Restarting from an older checkpoint was critical to get to pretrain the full model due to several failures (network, CUDA Errors, etc..).
+Info: The `Streaming DataLoader` was used by [Lit-GPT](https://github.com/Lightning-AI/litgpt/blob/main/tutorials/pretrain_tinyllama.md) to pretrain LLMs. Restarting from an older checkpoint was critical to get to pretrain the full model due to several failures (network, CUDA Errors, etc..).
 
 ```python
 import os

examples/multi_modal/README.md

@@ -126,7 +126,7 @@ pip install -r requirements.txt
 
 ## License
 
-This project is licensed under the APACHE 2.0 License. See the [LICENSE](LICENSE) file for details.
+This project is licensed under the [APACHE 2.0 License](https://github.com/Lightning-AI/litData/blob/main/LICENSE).
 
 ______________________________________________________________________