Test: Verify GitHub Action link checking workflow #16
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
- Create test-page.md with various link types to validate - Include internal links (index.md, useful-resources.md) - Include external links (github.com, python.org, sphinx-doc.org) - Add test page to main index toctree - This PR will test the automated link checking workflow functionality
Documentation build overview
Files changedShow files (5) | 2 modified | 3 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 - ✅ PASSEDReadTheDocs Preview: https://wafer-space--16.org.readthedocs.build/en/16/ 🎉 All links are valid! The link checker found no broken links in your documentation. |
- Change timeout from '30s' to '30' (muffet expects integer seconds) - Resolves 'invalid argument for flag -t, --timeout' error
- Remove unsupported flags: --user-agent, --color, --header, --one-page-only - Keep core functionality: rate limiting, timeouts, exclusions - Focus on basic link checking without advanced features
- Add realistic browser user agent to avoid 403 errors - Add browser-like headers (Accept, Accept-Language, Accept-Encoding) - Skip TLS verification to handle certificate issues - Follow redirects automatically - Increase timeout to 60 seconds for slow sites - Reduce rate limit to 5 req/sec to be more respectful - Add more exclusions for problematic sites (sourceforge, efabless, skywater) - Update documentation to explain configuration choices These changes address the common false positives in link checking: - 403 Forbidden (crawler detection) - Certificate errors (self-signed/expired certs) - DNS timeouts (slow/unreliable sites) - Redirect issues (not following redirects)
- Use --max-redirections instead of --follow-redirects - Use --header flags instead of environment variables - Add proper browser headers directly via --header - Use --color=never for clean output - Remove environment variables approach in favor of command-line flags This should resolve the 'unknown flag' errors and properly configure muffet to handle common link checking issues like: - 403 Forbidden (realistic User-Agent header) - Certificate errors (--skip-tls-verification) - Redirects (--max-redirections=10) - Timeouts (--timeout=60)
Link fixes: - Replace broken GF180MCU PDK sub-pages with main documentation link - Update OpenLane Workshop link to main OpenLane repository - Remove broken Efabless IP catalog link, replace with community projects - Replace broken Hackaday article with general IC testing resources Exclusion improvements: - Add allaboutcircuits.com (blocks crawlers) - Add globalfoundries.com (corporate site blocks crawlers) - Add klayout.de (slow/unreliable server) - Update documentation to explain exclusions These changes should resolve all remaining 403, 404, and timeout errors while maintaining valuable reference links for users.
- Minor update to test page to trigger GitHub Action - Previous commit fixed all broken links in useful-resources.md - Should now pass with all links valid
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.
🧪 Test PR: GitHub Action Verification
This PR tests the automated link checking GitHub Action workflow to verify it's functioning correctly.
What's Being Tested
New Test Page
test-page.md- Contains various link types for validationExpected GitHub Action Behavior
Test Scenarios Covered
Success Criteria
Notes
This is a test PR to validate our automated quality assurance process. If the GitHub Action works correctly, this demonstrates that future PRs will have reliable link validation.
🤖 Generated with Claude Code