feat: add broken links check script with api-reference filtering #861
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
- Add mintlify/check-links.sh script that filters out /api-reference links - Update GitHub workflow to use the new script for PR checks - Add testing instructions to CLAUDE.md - Script returns appropriate exit codes for CI/CD integration This improves the reliability of documentation link checking by excluding known false positives from api-reference paths. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds a broken links checking script that automatically filters out /api-reference links to eliminate false positives in documentation validation.
- Creates a shell script that wraps the
mint broken-linkscommand with intelligent filtering - Simplifies the GitHub workflow by removing complex comment generation and just running the script
- Updates documentation with testing instructions for local validation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
mintlify/check-links.sh |
New script that filters /api-reference links from broken link results |
mintlify/CLAUDE.md |
Adds testing section with instructions to run the link check script |
.github/workflows/broken-links.yml |
Simplified workflow that executes the script directly without PR comments |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Contributor
Author
|
example of a failed run: https://github.com/bytebase/bytebase.com/actions/runs/17316630676/job/49160607162 |
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.
Summary
Add a script to check for broken links in documentation while automatically filtering out
/api-referencelinks, which are known false positives.Changes
New script:
mintlify/check-links.shmint broken-linkscommand/api-referencelinks from resultsSimplified workflow:
.github/workflows/broken-links.ymlDocumentation: Updated
mintlify/CLAUDE.mdBenefits
/api-referencelinksTesting
Run locally with:
🤖 Generated with Claude Code