Fix the documentation link checker #1907
Description
Why are we doing this?
The Check links workflow is intended to ensure OpenSAFELY documentation remains accurate and free of broken links.
The documentation link checker GitHub Actions workflow is currently failing.
This issue was encountered while I was on tech support, and ownership sits with Team REX.
Dave investigated and confirmed that the links in the ehrQL documentation are correct and point to the right locations, so the failure is caused by the link checker itself, not by broken or malformed documentation links.
Refer slack thread and playbook for reference.
How will we know when it's done?
- The Check links workflow is successful.
- The underlying cause is understood and documented.
- Future runs do not incorrectly flag the same class of links.
What are we doing?
- Review the failing workflow logs to identify which links are being flagged and why
- Confirm that flagged links are valid and resolved
- Identify the root cause in the link checker
- Update the link checker configuration or tooling to correctly handle these links
- Re-run the workflow to confirm it passes
- Document the issue and resolution for future tech support reference