From eb86a3448bff4510f9d6208bfb5bf5e51a9b3825 Mon Sep 17 00:00:00 2001
From: One <43485962+c-git@users.noreply.github.com>
Date: Tue, 7 Jan 2025 13:44:09 -0500
Subject: [PATCH] ci: add job to check links

---
 .github/workflows/link_check.yml | 24 ++++++++++++++++++++++++
 src/lib.rs                       |  2 --
 2 files changed, 24 insertions(+), 2 deletions(-)
 create mode 100644 .github/workflows/link_check.yml

diff --git a/.github/workflows/link_check.yml b/.github/workflows/link_check.yml
new file mode 100644
index 0000000..6552630
--- /dev/null
+++ b/.github/workflows/link_check.yml
@@ -0,0 +1,24 @@
+name: Links Checker
+
+on:
+  pull_request: 
+    branches:
+      - main
+  schedule:
+    - cron: "12 02 4 * *"
+
+jobs:
+  link_checker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: wykies/checkout@main
+      - name: Restore lychee cache
+        uses: actions/cache@v4
+        with:
+            path: .lycheecache
+            key: cache-lychee-${{ github.ref }}
+            restore-keys: cache-lychee-
+      - name: Run lychee
+        uses: lycheeverse/lychee-action@v2
+        with:
+            args: --base . --cache --no-progress --require-https './**/*.md' './**/*.html' './**/*.rs'
\ No newline at end of file
diff --git a/src/lib.rs b/src/lib.rs
index b9824e7..c22367a 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -71,8 +71,6 @@
 //! [reqwest_client]:https://docs.rs/reqwest/latest/reqwest/struct.Client.html
 //! [examples_folder]: https://github.com/c-git/reqwest-cross/tree/main/examples
 
-// TODO 4: Add link checking to this crate
-
 mod data_state;
 mod platform;
 mod traits;