chore: add broken-links check

Author: tianzhou

.github/workflows/broken-links.yml

@@ -0,0 +1,103 @@
+name: Check Broken Links
+
+on:
+  pull_request:
+    paths:
+      - 'mintlify/**/*.mdx'
+    types: [opened, synchronize, reopened]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  check-broken-links:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+
+      - name: Install Mintlify CLI
+        run: npm install -g mintlify
+
+      - name: Check for broken links
+        id: broken-links
+        working-directory: mintlify
+        run: |
+          # Run mint broken-links and capture output
+          OUTPUT=$(mint broken-links 2>&1 || true)
+
+          # Filter out /api-reference/ false positives
+          FILTERED_OUTPUT=$(echo "$OUTPUT" | grep -v "/api-reference/" || true)
+
+          # Count real broken links (excluding the summary line)
+          BROKEN_COUNT=$(echo "$FILTERED_OUTPUT" | grep -E "^\s+/" | wc -l || echo "0")
+
+          # Save results to GitHub outputs
+          echo "broken_count=$BROKEN_COUNT" >> $GITHUB_OUTPUT
+
+          # Save filtered output to file for PR comment
+          if [ "$BROKEN_COUNT" -gt 0 ]; then
+            echo "$FILTERED_OUTPUT" > broken_links_output.txt
+            echo "has_broken_links=true" >> $GITHUB_OUTPUT
+          else
+            echo "✅ No broken links found" > broken_links_output.txt
+            echo "has_broken_links=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Comment on PR
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const fs = require('fs');
+            const brokenCount = '${{ steps.broken-links.outputs.broken_count }}';
+            const hasBrokenLinks = '${{ steps.broken-links.outputs.has_broken_links }}' === 'true';
+
+            let comment;
+            if (hasBrokenLinks) {
+              const output = fs.readFileSync('mintlify/broken_links_output.txt', 'utf8');
+              comment = `## 🔗 Broken Links Found\n\n${brokenCount} broken link(s) detected:\n\n\`\`\`\n${output}\`\`\`\n\n⚠️ Please fix these broken links before merging.`;
+            } else {
+              comment = `## ✅ Link Check Passed\n\nNo broken links found in the documentation files.`;
+            }
+
+            // Find existing comment
+            const { data: comments } = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+            });
+
+            const existingComment = comments.find(comment => 
+              comment.body.includes('🔗 Broken Links Found') || 
+              comment.body.includes('✅ Link Check Passed')
+            );
+
+            if (existingComment) {
+              // Update existing comment
+              await github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: existingComment.id,
+                body: comment
+              });
+            } else {
+              // Create new comment
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: context.issue.number,
+                body: comment
+              });
+            }
+
+      - name: Fail if broken links found
+        if: steps.broken-links.outputs.has_broken_links == 'true'
+        run: |
+          echo "❌ ${{ steps.broken-links.outputs.broken_count }} broken link(s) found"
+          exit 1

mintlify/change-database/troubleshoot.mdx

@@ -6,7 +6,7 @@ title: Troubleshoot
 
 This happens if a migration version has already completed successfully and you are trying to apply the same version. Once the migration is successful, its version string is occupied and can't be reused. You can still retry the failed migration.
 
-This error is more common in GitOps flow when you try to modify an existing migration file. Refer to the [GitOps troubleshoot](/change-database/troubleshoot#duplicate-version)
+This error is more common in GitOps flow when you try to modify an existing migration file. Refer to the [GitOps troubleshoot](/change-database/troubleshoot1#duplicate-version)
 to learn the correct workflow.
 
 ## PostgreSQL

mintlify/snippets/install/install-upgrade.mdx

@@ -4,7 +4,7 @@ title: Install and Upgrade
 
 ## ⚙️ Install and Upgrade
 
-- Fresh install: [/get-started/self-host/deploy-with-docker](/get-started/self-host/deploy-with-docker)
+- Fresh install: [/get-started/self-host/deploy-with-docker](/get-started/self-2host/deploy-with-docker)
 
 - Upgrade: [/get-started/self-host/upgrade](/get-started/self-host/upgrade)