Add documentation link checking and fix broken links #404
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
This addresses issue ga4gh#313 by implementing comprehensive link checking for documentation. Changes: - Add GitHub workflow for automated link checking using sphinx-build -b linkcheck - Fix malformed VRS URL in variant.rst (removed duplicate https://) - Fix obsolete GitHub organization reference in version2.rst - Update sphinx configuration to use modern CSS API and set language to 'en' - Configure linkcheck to run on push/PR to docs, weekly schedule, and manual dispatch The link checker identifies ~109 broken/redirected links across the documentation, providing a foundation for future link maintenance. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
|
- Remove scheduled cron run as requested - Update to actions/upload-artifact@v4 (v3 deprecated) - Remove --keep-going flag so job fails on broken links
|
Thanks for the feedback! I've addressed both issues: ✅ Removed scheduled run - No more weekly cron job The workflow will now:
The next workflow run should pass the action setup but correctly fail due to the broken links identified in the documentation. |
- Added linkcheck_allowed_redirects to treat all redirects as successful - Added specific ignore patterns for sites that block bots but are functional - Added anchor ignore patterns for sites with problematic anchor checking - Configured reasonable timeout and worker settings for efficient checking This reduces false positives from ~109 redirect 'errors' to ~23 genuine broken links.
|
✅ Configured linkcheck to allow redirects Updated the sphinx configuration to treat redirects as successful while still catching genuine broken links: Configuration Changes
Results
The workflow will now focus on real issues rather than being noisy about harmless redirects. 🎯 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
This PR addresses issue #313 by implementing comprehensive link checking for documentation and fixing several broken links.
Changes Made
sphinx-build -b linkcheckhttps://)Link Check Results
The link checker identifies ~109 broken/redirected links across the documentation, including:
Test Plan
The workflow will now automatically check for broken links on documentation changes and run weekly to catch external link breakage.
🤖 Generated with Claude Code