Repository navigation
Add lychee GitHub action to automatically check for broken links #134
Description
Add Github Action workflow that checks for broken links.
This should check both external links and internal references.
Follow the approach we used in the SIPNET repository (.github/workflows/link-check.yml, implement a Lychee GHA
Confirm that broken links in sub-issues are caught by checker. Make sure those are fixed alongside this implementation.
Activity
Avneetsingh18-doit commentedon Jan 31, 2026
Hi, please assign this issue to me. my approach: I will check all the links in the repository, find any broken ones, fix them, and push the changes.
dlebauer commentedon Feb 1, 2026
@Avneetsingh18-doit thanks for your interest! Could you please review #135 and see if that is a fix, and if any changes are needed?
Avneetsingh18-doit commentedon Feb 1, 2026
Hi @dlebauer, sure I’ll review PR #135 and get back with feedback shortly.
Avneetsingh18-doit commentedon Feb 7, 2026
I reviewed the workflow and tested the link checker with a few configuration tweaks . With some adjustments, we should be able to surface the broken links that were previously reported. If this sounds good, please feel free to assign this to me and I can raise a follow-up PR to address it.
dlebauer commentedon Mar 17, 2026
Thanks, @Avneetsingh18-doit - I've assigned it to you.
Avneetsingh18-doit commentedon Mar 21, 2026
Sure @dlebauer
ANAMASGARD commentedon May 5, 2026
Sir @dlebauer just a follow up is this issue still open is anyone working on it , if not I would like to work on it , Thank You .
ANAMASGARD commentedon Jul 20, 2026
Hi @dlebauer, I tested a localhost-based Lychee setup against the rendered Docusaurus site.
It correctly detects internal route failures, including these four currently broken links from the Package Documentation
page:
Could you please confirm the intended destination URL for each of these package-documentation versions? I do not want to
guess and point users to the wrong documentation.
I also found a larger backlog of historical external links that return 404, 410, authentication, or bot-blocking
responses. Would you be comfortable with splitting the eventual workflow into:
I have not opened a PR yet, since the workflow would otherwise remain permanently failing.