chore: add broken-links check

Author: tianzhou

.github/workflows/broken-links.yml

@@ -0,0 +1,128 @@
+name: Check Broken Links in MDX Files
+
+on:
+  pull_request:
+    paths:
+      - 'mintlify/**/*.mdx'
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  check-broken-links:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout repository
+        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: Run broken links check
+        id: broken-links
+        working-directory: mintlify
+        run: |
+          echo "Running mint broken-links in mintlify directory..."
+          
+          # Run broken links check and capture both stdout and stderr
+          set +e  # Don't exit on error
+          mint broken-links &> broken-links-output.txt
+          mint_exit_code=$?
+          set -e  # Re-enable exit on error
+          
+          echo "mint_exit_code=$mint_exit_code" >> $GITHUB_OUTPUT
+          
+          # Show original output for debugging
+          echo "Original mint output:"
+          cat broken-links-output.txt
+          
+          # Filter out /api-reference/ false positives
+          grep -v "/api-reference/" broken-links-output.txt > filtered-output.txt || true
+          
+          # Count non-empty lines in filtered output (excluding the header and empty lines)
+          filtered_line_count=$(grep -c . filtered-output.txt || echo "0")
+          
+          # Check if there are any remaining broken links
+          # We need to account for the "Checking for broken links..." line and count line
+          if [ "$filtered_line_count" -gt 2 ]; then
+            echo "has_broken_links=true" >> $GITHUB_OUTPUT
+            echo "FILTERED_OUTPUT<<EOF" >> $GITHUB_OUTPUT
+            cat filtered-output.txt >> $GITHUB_OUTPUT
+            echo "EOF" >> $GITHUB_OUTPUT
+          else
+            echo "has_broken_links=false" >> $GITHUB_OUTPUT
+            echo "FILTERED_OUTPUT=✅ No broken links found (after filtering out /api-reference/ paths)" >> $GITHUB_OUTPUT
+          fi
+          
+      - name: Comment on PR
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const hasBrokenLinks = '${{ steps.broken-links.outputs.has_broken_links }}' === 'true';
+            const filteredOutput = `${{ steps.broken-links.outputs.FILTERED_OUTPUT }}`;
+            
+            let body;
+            if (hasBrokenLinks) {
+              body = `## 🔗 Broken Links Check Failed
+            
+            The following broken links were found in the MDX files (after filtering out \`/api-reference/\` paths):
+            
+            \`\`\`
+            ${filteredOutput}
+            \`\`\`
+            
+            Please fix these broken links before merging.
+            
+            > **Note**: Links under \`/api-reference/\` are automatically filtered out as they may be false positives.`;
+            } else {
+              body = `## ✅ Broken Links Check Passed
+            
+            ${filteredOutput}
+            
+            All MDX files in the \`mintlify/\` directory have been checked for broken links.
+            
+            > **Note**: Links under \`/api-reference/\` are automatically filtered out as they may be false positives.`;
+            }
+            
+            // Find existing comment
+            const comments = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+            });
+            
+            const existingComment = comments.data.find(comment => 
+              comment.user.login === 'github-actions[bot]' && 
+              comment.body.includes('Broken Links Check')
+            );
+            
+            if (existingComment) {
+              // Update existing comment
+              await github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: existingComment.id,
+                body: body
+              });
+            } else {
+              // Create new comment
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: context.issue.number,
+                body: body
+              });
+            }
+            
+      - name: Fail if broken links found
+        if: steps.broken-links.outputs.has_broken_links == 'true'
+        run: |
+          echo "Broken links found after filtering out /api-reference/ paths!"
+          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)