chore: action for validating doc links

Signed-off-by: Pranav C <pranavxc@gmail.com>

.github/workflows/validate-docs-links.yml

@@ -0,0 +1,28 @@
+name: "Validate: Docs"
+
+on:
+  # Triggered manually
+  workflow_dispatch:
+  pull_request:
+    types: [opened, reopened, synchronize, ready_for_review, labeled]
+    branches: [develop]
+    paths:
+      - "packages/noco-docs/**"
+
+jobs:
+  validate-docs:
+    runs-on: [self-hosted, aws]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18.19.1
+      - name: Build docs
+        run: |
+          cd packages/noco-docs
+          npm install
+          npm run generate
+          npm run remark:once

packages/noco-docs/package.json

@@ -25,7 +25,9 @@
     "serve": "docusaurus serve --dir dist",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
-    "typecheck": "tsc"
+    "typecheck": "tsc",
+    "remark": "remark",
+    "remark:once": "npm run remark -- --quiet --frail --use remark-validate-links docs/"
   },
   "dependencies": {
     "@docusaurus/core": "3.1.1",
@@ -48,6 +50,8 @@
   "devDependencies": {
     "@docusaurus/module-type-aliases": "3.1.1",
     "@tsconfig/docusaurus": "^1.0.7",
+    "remark-cli": "^12.0.1",
+    "remark-validate-links": "^13.0.1",
     "typescript": "^4.9.5"
   },
   "browserslist": {