Add automated link checking for ReadTheDocs previews #15
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 comprehensive link-check.yml workflow that waits for ReadTheDocs preview deployment - Uses muffet tool to validate all internal and external links - Provides detailed PR comments with results and artifacts - Excludes social media domains that typically block crawlers - Includes rate limiting and proper user agent for respectful crawling - Fails PR if broken links are found to prevent merging broken documentation - Add workflow documentation and update CLAUDE.md with testing info
Documentation build overview
Files changedShow files (2) | 1 modified | 1 added | 0 deleted
|
- Add required permissions for commenting on PRs (pull-requests: write, issues: write) - Fix ReadTheDocs URL pattern to use .org.readthedocs.build domain - Update documentation to reflect correct URL pattern - Resolves permission errors and incorrect URL construction
🔍 Link Check Results - ❌ FAILEDReadTheDocs Preview: https://wafer-space--15.org.readthedocs.build/en/15/ 🔍 Click to view detailed results📊 Full results are available in the workflow artifacts. |
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
Adds a comprehensive GitHub Action workflow that automatically validates all links in ReadTheDocs preview deployments for pull requests.
Features
Workflow Details
Benefits
Test Plan
🤖 Generated with Claude Code