ci: add doc link verification (#271)

* ci: add doc link verification

* Fix lockfile

Author: lachlancollins

.github/workflows/autofix.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Setup Tools
         uses: ./.github/setup
       - name: Fix formatting
-        run: pnpm prettier:write
+        run: pnpm run prettier:write
       - name: Apply fixes
         uses: autofix-ci/action@635ffb0c9798bd160680f18fd73371e355b85f27
         with:

.github/workflows/pr.yml

@@ -30,6 +30,8 @@ jobs:
           main-branch-name: main
       - name: Run Checks
         run: pnpm run test:pr
+      - name: Verify Links
+        run: pnpm run verify-links
   preview:
     name: Preview
     runs-on: ubuntu-latest

docs/overview.md

@@ -39,12 +39,12 @@ pnpm add -D @tanstack/vite-config
 
 ## Utilities
 
-- [ESLint](./eslint.md)
-- [Publish](./publish.md)
-- [Vite](./vite.md)
+- [ESLint](../eslint.md)
+- [Publish](../publish.md)
+- [Vite](../vite.md)
 
 ## Conventions
 
-- [CI/CD](./ci-cd.md)
-- [Dependencies](./dependencies.md)
-- [Package Structure](./package-structure.md)
+- [CI/CD](../ci-cd.md)
+- [Dependencies](../dependencies.md)
+- [Package Structure](../package-structure.md)

docs/package-structure.md

@@ -19,7 +19,7 @@ The following structure ensures packages work optimally with our monorepo/Nx wor
 
 ### `./vite.config.ts`
 
-- Includes config for Vitest, and for Vite if [@tanstack/config/vite](./vite.md) is used
+- Includes config for Vitest, and for Vite if [@tanstack/config/vite](../vite.md) is used
 
 ### `./src`
 

package.json

@@ -23,6 +23,7 @@
     "dev": "pnpm run watch",
     "prettier": "prettier --experimental-cli --ignore-unknown '**/*'",
     "prettier:write": "pnpm run prettier --write",
+    "verify-links": "node scripts/verify-links.ts",
     "changeset": "changeset",
     "changeset:version": "changeset version && pnpm install --no-frozen-lockfile && pnpm prettier:write",
     "changeset:publish": "changeset publish"
@@ -39,10 +40,13 @@
     "@types/node": "catalog:",
     "eslint": "catalog:",
     "jsdom": "catalog:",
+    "markdown-link-extractor": "catalog:",
     "nx": "catalog:",
     "prettier": "catalog:",
     "publint": "catalog:",
     "sherif": "catalog:",
-    "typescript": "catalog:"
+    "tinyglobby": "catalog:",
+    "typescript": "catalog:",
+    "typescript-eslint": "catalog:"
   }
 }