Link checker across nix documentation properties
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
Observations
If we add more links, they might break. We can automate finding broken links between our things, in principle, and run it in ci. One difficulty is that the repos aren't versioned together but this could be overcome.
Cargo's book has a link checker iirc, could maybe use that.
Problem
With more links come more possibilities to break them. We could catch the breakage automatically.
Approaches
Write script that reads html files of built sites, soups the links out, and validates the target files exist with the appropriate anchors. Run in CI here or elsewhere.
Willing to help?
Sure
Priorities
Add 👍 to issues you find important.
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 reviewing how the built documentation sites are produced and where CI workflows are defined. Compare the proposed approach with Cargo's book link checker, then determine how to read built HTML, validate target files and anchors across separately versioned repositories, and run the check in CI. Done means broken links are detected automatically.
Written by the indexing model from the issue text.
Assessment
- Domain
- ci-cd, documentation, testing
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100