Consider switching to `lycheeLinkCheck` for link checking
Open
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
Link checks seem to be a bit flaky, but also they use the links directly from the parsed MyST as opposed to lychee parsing them from sources.
https://nixos.org/manual/nixpkgs/stable/#tester-lycheeLinkCheck
Originally posted by @roberth in https://github.com/NixOS/nix.dev/issues/1099#issuecomment-2615906971
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 locating the current link-check configuration described in the issue and compare it with the linked lycheeLinkCheck documentation. Determine whether switching is feasible and document the required scope; done means the link checks use the proposed approach without the reported flakiness.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100