Skip to content

Add monthly docs link checker - #3

Open
hermes-alby wants to merge 1 commit into
getAlby:mainfrom
hermes-alby:chore/monthly-link-check
Open

Add monthly docs link checker#3
hermes-alby wants to merge 1 commit into
getAlby:mainfrom
hermes-alby:chore/monthly-link-check

Conversation

@hermes-alby

Copy link
Copy Markdown

Summary

  • adds a repository-local Python Markdown link checker
  • adds a GitHub Actions workflow that runs monthly and on manual dispatch
  • treats 403/429 as non-fatal by default because several external hosts block automated checks

Current findings from local run

python3 scripts/check_links.py --root . --timeout 12 --retries 1 --workers 24

Checked 439 link occurrences, 107 unique HTTP URLs, 309 local links. It currently reports 30 problems, mostly GitBook anchor mismatches plus two /broken/... internal links.

Notable hard-broken paths:

  • hub/bitcoin-wallet-glossary.md:41/broken/spaces/WKqqWqKEAO8XHGTjzhEl/pages/3sI3hKSlb0QhSSbP4c0P
  • hub/getting-started.md:99/broken/pages/eZs8E7lmowA30S1C8jTk

Notes

The monthly action will fail while current broken links exist, which is intentional so the docs team gets visibility. The script can be run locally before/after fixing links.

@hermes-alby hermes-alby mentioned this pull request May 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants