From 3a716a9c802e45328b2920ddc53323f9fbe8cddf Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Orhun=20Parmaks=C4=B1z?= <orhunparmaksiz@gmail.com>
Date: Mon, 5 Aug 2024 18:59:17 +0300
Subject: [PATCH] Add link checker for the documentation

---
 .github/workflows/docs.yml | 27 +++++++++++++++++++++++++++
 .lycheeignore              |  3 +++
 README.md                  |  2 +-
 ddosify_engine/README.md   |  2 +-
 4 files changed, 32 insertions(+), 2 deletions(-)
 create mode 100644 .github/workflows/docs.yml
 create mode 100644 .lycheeignore

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 00000000..ad310950
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,27 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+    branches:
+      - master
+      - develop
+
+jobs:
+  link-checker:
+    name: Check links
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+
+      - name: Check the links
+        uses: lycheeverse/lychee-action@v1
+        with:
+          args: --max-concurrency 1 -v *.md **/*.md
+          fail: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.lycheeignore b/.lycheeignore
new file mode 100644
index 00000000..9bb9929a
--- /dev/null
+++ b/.lycheeignore
@@ -0,0 +1,3 @@
+https://getanteon.com/endpoint_1
+https://getanteon.com/endpoint_2
+http://localhost:8014/
diff --git a/README.md b/README.md
index e4fc27bb..671425d5 100644
--- a/README.md
+++ b/README.md
@@ -70,7 +70,7 @@ Anteon Stack consists of 4 parts:
 
 ### Anteon Load Engine (Ddosify)
 
-[Ddosify](https://github.com/getanteon/anteon/tree/master/ddosify_engine) is the load engine, written in Golang. It's a CLI load-testing tool. Anteon Self-Hosted and Anteon Cloud use it under the hood for load generation. It is fully open-source and can be used on the CLI as a standalone tool. It has ~8K Github Stars. Ddosify is available via [Docker](https://hub.docker.com/r/ddosify/ddosify), [Docker Extension](https://hub.docker.com/extensions/getanteon/anteon-docker-extension), [Homebrew Tap](https://github.com/getanteon/anteon/tree/master/ddosify_engine#homebrew-tap-macos-and-linux), and downloadable pre-compiled binaries from the [releases page](https://github.com/getanteon/anteon/releases/tag/v1.0.6) for macOS, Linux, and Windows.
+[Ddosify](https://github.com/getanteon/anteon/tree/master/ddosify_engine) is the load engine, written in Golang. It's a CLI load-testing tool. Anteon Self-Hosted and Anteon Cloud use it under the hood for load generation. It is fully open-source and can be used on the CLI as a standalone tool. It has ~8K Github Stars. Ddosify is available via [Docker](https://hub.docker.com/r/ddosify/ddosify), [Docker Extension](https://hub.docker.com/extensions/ddosify/ddosify-docker-extension), [Homebrew Tap](https://github.com/getanteon/anteon/tree/master/ddosify_engine#homebrew-tap-macos-and-linux), and downloadable pre-compiled binaries from the [releases page](https://github.com/getanteon/anteon/releases/tag/v1.0.6) for macOS, Linux, and Windows.
 
 Check out the [Ddosify Docs](https://github.com/getanteon/anteon/tree/master/ddosify_engine) page for more information and usage.
 
diff --git a/ddosify_engine/README.md b/ddosify_engine/README.md
index 222974e3..c8b7a50b 100644
--- a/ddosify_engine/README.md
+++ b/ddosify_engine/README.md
@@ -931,7 +931,7 @@ On array-like captured variables or environment vars, the **rand( )** function c
 ## Test Data Set
 Ddosify enables you to load test data from **CSV** files. Later, in your scenario, you can inject variables that you tagged.
 
-We are using this [CSV data](https://github.com/getanteon/anteon/tree/master/config/config_testdata/test.csv) in below config.
+We are using this [CSV data](https://github.com/getanteon/anteon/tree/master/ddosify_engine/config/config_testdata/test.csv) in below config.
 
 
 ```json