Broken links pipeline

.github/workflows/check-broken-links.yml

@@ -0,0 +1,35 @@
+name: check-broken-links
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    permissions: write-all
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Checkout PR
+        if: github.event_name == 'pull_request_target'
+        run: |
+          git fetch origin pull/${{ github.event.pull_request.number }}/head:pr-${{ github.event.pull_request.number }}
+          git checkout pr-${{ github.event.pull_request.number }}
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - name: Install Dependencies
+        shell: bash
+        run: pnpm install        
+
+      - name: Run fern broken links check
+        env:
+          FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
+        run: pnpm docs:brokenLinks --strict
+

package.json

@@ -9,6 +9,7 @@
     "docs:check": "pnpm compile && fern check",
     "docs:publish": "pnpm compile && fern generate --docs",
     "docs:preview": "pnpm compile && fern generate --docs --preview --log-level debug",
+    "docs:brokenLinks": "pnpm compile && fern docs broken-links",
     "prepublish": "exit 1"
   },
   "devDependencies": {