Fix links found by linkcheck; make linkcheck non-blocking

- index.md: quickstart link pointed to a deleted page (404) — now
  points to docs/worker/getting-started.md
- worker.md: drop fragile #dependencies anchor
- Ignore usenix.org in linkcheck (403s automated checkers but works
  in-browser) and GitHub anchor checks; cap linkcheck retries and
  rate-limit wait so it stays fast
- deploy.yml: move linkcheck to its own non-blocking job so rate-limit
  back-off never delays or blocks the build/deploy

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Author: mariaob1201

.github/workflows/deploy.yml

@@ -39,11 +39,6 @@ jobs:
       - name: Build Jupyter Book
         run: jupyter-book build . --warningiserror
 
-      - name: Check links
-        # Informational: external links can be flaky, so this never blocks the build.
-        continue-on-error: true
-        run: jupyter-book build . --builder linkcheck
-
       - name: Setup Pages
         if: github.event_name == 'push'
         uses: actions/configure-pages@v6
@@ -54,6 +49,25 @@ jobs:
         with:
           path: _build/html
 
+  # Link checking runs independently and never blocks the build or deploy:
+  # external links can be flaky or rate-limit automated checkers.
+  linkcheck:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Check links
+        run: jupyter-book build . --builder linkcheck
+
   deploy:
     needs: build
     if: github.event_name == 'push' && github.ref == 'refs/heads/master'

_config.yml

@@ -64,6 +64,20 @@ sphinx:
     # ---- Custom 404 page ----
     # This is a root (user/org) Pages site, so served from "/".
     notfound_urls_prefix: "/"
+
+    # ---- Link checking ----
+    # usenix.org returns 403 to automated checkers (bot protection) but the
+    # links resolve fine in a browser, so skip them in linkcheck.
+    linkcheck_ignore:
+      - "https://www\\.usenix\\.org/.*"
+    # GitHub blob pages render heading anchors with client-side JS that
+    # linkcheck can't see; don't fail on missing anchors there.
+    linkcheck_anchors_ignore_for_url:
+      - "https://github\\.com/.*"
+    # Keep linkcheck fast: cap retries and how long we wait out a rate limit.
+    linkcheck_timeout: 15
+    linkcheck_retries: 1
+    linkcheck_rate_limit_timeout: 30
     html_theme_options:
       use_download_button: false
       navigation_depth: 2

index.md

@@ -21,7 +21,7 @@ The main system implemented so far is a **single-node OpenLambda worker** that c
 HTTP requests and invoke lambdas locally to compute responses.
 
 You can read more about the OpenLambda worker on the [Worker page](worker.md), or just get
-started by [deploying a worker](https://github.com/open-lambda/open-lambda/blob/main/docs/quickstart.md).
+started by [deploying a worker](https://github.com/open-lambda/open-lambda/blob/main/docs/worker/getting-started.md).
 
 ```{note}
 We are currently working on a **cluster mode**, where a pool of VMs running the worker

worker.md

@@ -43,7 +43,8 @@ The worker supports three kinds of triggers:
 
 OpenLambda is actively tested on **Ubuntu 24.04 LTS**, requires **cgroups v2**, and relies on
 operations that need root privilege. After installing the
-[dependencies](https://github.com/open-lambda/open-lambda/blob/main/docs/worker/getting-started.md#dependencies),
+dependencies listed in the
+[getting-started guide](https://github.com/open-lambda/open-lambda/blob/main/docs/worker/getting-started.md),
 build the Python-only ("min") deployment:
 
 ```bash