Added link checker

Author: mnocon

.github/workflows/link_check.yaml

@@ -0,0 +1,61 @@
+name: "Check documentation links"
+
+on:
+    push:
+        branches:
+            - master
+            - "[0-9]+.[0-9]+"
+    workflow_dispatch: ~
+    pull_request: ~
+
+jobs:
+    link-check:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                python-version: [3.13]
+
+        steps:
+            - uses: actions/checkout@v4
+
+            - name: Set up Python ${{ matrix.python-version }}
+              uses: actions/setup-python@v5
+              with:
+                  python-version: ${{ matrix.python-version }}
+
+            - name: Install MkDocs dependencies
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install -r requirements.txt
+
+            - name: Build documentation
+              run: mkdocs build --strict
+
+            - name: Restore lychee cache
+              uses: actions/cache@v4
+              with:
+                  path: .lycheecache
+                  key: lychee-${{ github.ref_name }}-${{ hashFiles('lychee.toml') }}
+                  restore-keys: |
+                      lychee-${{ github.ref_name }}-
+                      lychee-
+
+            - name: Check links
+              uses: lycheeverse/lychee-action@v2
+              with:
+                  args: >-
+                      --config lychee.toml
+                      --cache
+                      --cache-exclude-status "500.."
+                      site
+                  fail: true
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+            - name: Upload link-check report
+              if: always()
+              uses: actions/upload-artifact@v4
+              with:
+                  name: lychee-report
+                  path: lychee-report.md
+                  if-no-files-found: ignore

lychee

@@ -0,0 +1 @@
+Subproject commit 97a086a6900feaccf161fd03c23d26e2eaf02c4d

lychee.toml

@@ -0,0 +1,106 @@
+#############################  Display  #############################
+
+# Verbose program output
+verbose = "warn"
+
+# Output format
+format = "markdown"
+
+# Path to report output file
+output = "lychee-report.md"
+
+# Don't show interactive progress bar while checking links.
+no_progress = false
+
+#############################  Cache  ###############################
+
+# Enable link caching to avoid re-checking identical links across runs.
+cache = true
+
+# Discard cached results older than this duration.
+max_cache_age = "1d"
+
+#############################  Runtime  #############################
+
+# Maximum number of allowed redirects.
+max_redirects = 10
+
+# Maximum number of allowed retries before a link is declared dead.
+max_retries = 3
+
+# Minimum wait time in seconds between retries of failed requests.
+retry_wait_time = 2
+
+# Maximum number of concurrent link checks.
+max_concurrency = 16
+
+#############################  Requests  ############################
+
+# Website timeout from connect to response finished (seconds).
+timeout = 20
+
+# Comma-separated list of accepted status codes for valid links.
+# 429 = Too Many Requests (rate-limited, treat as valid).
+accept = ["200", "429"]
+
+# Proceed for server connections considered insecure (invalid TLS).
+insecure = false
+
+# Only test links with these schemes.
+scheme = ["https", "http"]
+
+# Request method
+method = "get"
+
+# Enable the checking of anchor fragments in links.
+include_fragments = true
+
+# Do NOT check links inside <code> and <pre> blocks.
+include_verbatim = false
+
+#############################  Exclusions  ##########################
+
+# Skip missing input files instead of erroring.
+skip_missing = false
+
+# Exclude URLs from checking (treated as regular expressions).
+exclude = [
+    # LinkedIn blocks automated requests
+    "^https?://(www\\.)?linkedin\\.com",
+    # Localhost and loopback addresses
+    "^https?://localhost",
+    "^https?://127\\.0\\.0\\.1",
+    # Placeholder/example domains
+    "^https?://example\\.com",
+    # GitHub login/auth pages often rate-limit or redirect bots
+    "^https?://github\\.com/login",
+    # Internal documentation anchor-only references (handled by MkDocs build)
+    "^#",
+]
+
+# Exclude these paths from being checked.
+exclude_path = [
+    # Generated search index and assets have no meaningful links
+    "site/search",
+    "site/assets",
+    # 404 page
+    "site/404.html",
+    # Sitemap and robots files
+    "site/sitemap.xml",
+    "site/robots.txt",
+]
+
+# Check the specified file extensions
+extensions = ["html"]
+
+# Exclude all private IPs from checking.
+exclude_all_private = true
+
+#############################  Local files  #########################
+
+# Root path used to resolve absolute local links (e.g. /en/latest/page/).
+# Must match the directory passed as input to lychee.
+root_dir = "site"
+
+# Base URL for resolving relative links in HTML files.
+base_url = "https://doc.ibexa.co/en/latest/"