chore: improve lychee config and rename GH_TOKEN to GITHUB_TOKEN (#1063)

* rename GH_TOKEN to GITHUB_TOKEN

Aligns with the standard env var name that tools like lychee
read automatically for GitHub API authentication.

Co-Authored-By: Claude <noreply@anthropic.com>

* improve lychee link checker config

- Exclude localhost URLs (code examples, not real links)
- Exclude Google Trends (always rate-limits bots)
- Source .env before running lychee so GITHUB_TOKEN is available
  locally to avoid GitHub rate limiting

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: dslovinsky <dslovinsky@users.noreply.github.com>
Co-authored-by: Claude <noreply@anthropic.com>

Author: dslovinsky

.env.example

@@ -4,7 +4,7 @@
 
 # GitHub API (Required for SDK indexer and production mode)
 # Permissions needed: public_repo (read access to public repositories)
-GH_TOKEN=your_github_token_here
+GITHUB_TOKEN=your_github_token_here
 
 # Redis / Upstash KV (Required for all indexers)
 # Used to store path indices and navigation trees

.github/workflows/index-main-content.yml

@@ -42,7 +42,6 @@ jobs:
           KV_REST_API_URL: ${{ secrets.KV_REST_API_URL }}
           ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
           ALGOLIA_ADMIN_API_KEY: ${{ secrets.ALGOLIA_ADMIN_API_KEY }}
-          GH_TOKEN: ${{ secrets.GH_TOKEN }}
 
       - name: Revalidate docs index and nav caches
         run: |

lychee.toml

@@ -11,6 +11,8 @@ exclude = [
     ".*\\{.*\\}.*",                 # Any path containing curly braces {} - code examples aren't crawlable links
     ".*g\\.alchemy\\.com.*",        # Any path containing g.alchemy.com - RPC endpoints require API keys
     ".*\\.mdx$",                    # Links to MDX files - these should only be for snippets, not HTML pages
+    "^https?://localhost",           # Localhost URLs are code examples, not real links
+    ".*trends\\.google\\.com.*",     # Google Trends always rate-limits bots
 ]
 
 # Include these patterns even if they match exclude patterns

package.json

@@ -30,7 +30,7 @@
     "lint:eslint:fix": "eslint --fix",
     "lint:prettier": "prettier --cache --check \"{src,scripts}/**/*.{js,jsx,ts,tsx,md,mjs,mts,json,yml,yaml}\"",
     "lint:prettier:fix": "pnpm run lint:prettier --write",
-    "lint:broken-links": "lychee .",
+    "lint:broken-links": "[ -f .env ] && set -a && . ./.env && set +a; lychee .",
     "add-evm-chain": "tsx ./scripts/add-evm-chain.ts",
     "prepare": "husky",
     "preview": "tsx src/content-indexer/preview.ts --branch=$(git rev-parse --abbrev-ref HEAD)",