(ci): Docs link checker.

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+name: Docs checks
+
+on:
+  pull_request:
+    paths:
+      - "docs/**"
+      - ".github/actions/validate-docs-links/**"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  validate-docs-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: "Setup Node"
+        uses: ./.github/actions/setup-node
+
+      - name: "Run link checker"
+        run: cd docs && pnpm run check-links
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/README.MD

@@ -0,0 +1,9 @@
+# GitHub Action for Validating Documentation Links
+
+This action ensures that internal links in `.mdx` files in the `/docs/` directory are valid. It runs on every pull request that includes changes to these files.
+
+The action is triggered by the workflow defined in `.github/workflows/validate-docs-links.yml`.
+
+## Usage
+
+pnpm check-links

docs/package.json

@@ -0,0 +1,28 @@
+{
+  "private": true,
+  "type": "module",
+  "exports": "./dist/index.js",
+  "files": [
+    "src"
+  ],
+  "scripts": {
+    "check-links": "tsx validate-docs-links.ts"
+  },
+  "devDependencies": {
+    "@types/github-slugger": "^1.3.0",
+    "@vercel/ncc": "0.34.0",
+    "tsx": "^4.7.2",
+    "typescript": "5.1.6"
+  },
+  "dependencies": {
+    "@actions/core": "^1.10.0",
+    "@actions/github": "^5.1.1",
+    "github-slugger": "1.2.0",
+    "gray-matter": "4.0.2",
+    "rehype-raw": "4.0.1",
+    "remark-parse": "7.0.1",
+    "remark-rehype": "5.0.0",
+    "unified": "8.4.1",
+    "unist-util-visit": "2.0.0"
+  }
+}

docs/repo-docs/crafting-your-repository/caching.mdx

@@ -11,7 +11,7 @@ Turborepo uses caching to speed up builds, ensuring you **never do the same work
 
 ![12 tasks are being ran in 3 packages, resulting in a ">>> FULL TURBO" cache hit. The total time it takes to restore these tasks from cache is 80 milliseconds.](/images/docs/why-turborepo-solution.png)
 
-Turborepo's caching results in significant time savings when working locally - and is even more powerful when [Remote Caching](/repo/docs/core-concepts/remote-caching) is enabled, sharing a cache among your entire team and CI.
+Turborepo's caching results in significant time savings when working locally - and is even more powerful when [Remote Caching](/repo/d/core-concepts/remote-caching) is enabled, sharing a cache among your entire team and CI.
 
 On this page, you'll learn:
 

docs/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "noEmit": true,
+    "target": "esnext",
+    "moduleResolution": "node",
+    "strict": true,
+    "noImplicitAny": true,
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["validate-docs-links.ts", "types.d.ts"]
+}

docs/types.d.ts

@@ -0,0 +1,2 @@
+declare module "remark-rehype";
+declare module "rehype-raw";