opensafely / opensafely/documentation
Investigate why link check doesn't catch broken URLs in the ehrQL documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
As mentioned in opensafely-core/ehrql#1815 — there are broken links fixed up there, but the link check currently passes.
Not sure why: we should try and figure this out.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the documentation link-check configuration and reproducing its run against the ehrQL documentation, using opensafely-core/ehrql#1815 as the known broken-link example. Done means identifying why those broken URLs pass and documenting the cause and required correction.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing-qa
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100