chore: add broken-links check #793
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds a GitHub Actions workflow to automatically check for broken links in Mintlify documentation files when pull requests are opened or updated. The workflow helps maintain documentation quality by detecting broken internal links before they are merged.
- Introduces a GitHub Actions workflow that runs broken link checks on MDX files
- Adds automated PR commenting to report broken link findings
- Includes workflow failure mechanism when broken links are detected
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
.github/workflows/broken-links.yml |
New GitHub Actions workflow for checking broken links in documentation |
mintlify/snippets/install/install-upgrade.mdx |
Contains a broken link that appears to be intentionally added for testing |
mintlify/change-database/troubleshoot.mdx |
Contains another broken link that appears to be intentionally added for testing |
| ## ⚙️ 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) |
There was a problem hiding this comment.
The link path contains a typo: 'self-2host' should be 'self-host'. This creates a broken link.
Suggested change
| - Fresh install: [/get-started/self-host/deploy-with-docker](/get-started/self-2host/deploy-with-docker) | |
| - Fresh install: [/get-started/self-host/deploy-with-docker](/get-started/self-host/deploy-with-docker) |
| 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) |
There was a problem hiding this comment.
The link path contains an invalid reference: 'troubleshoot1' should be 'troubleshoot'. This creates a broken link.
Suggested change
| 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) | |
| 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) |
📝 Broken Links Check Report
The following is the output from the broken links check: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.