Periodically checking external links in documentation
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 27.2k
- Forks
- 3.9k
- Avg merge
- 2d 16h
- Merged PRs (30d)
- 17
Description
I had recently sent a PR to fix a broken link in documentation in: https://github.com/libuv/libuv/pull/3312
For checking broken links, I had used an open source link checking tool called lychee. The same lychee tool can also be used as GitHub Actions using https://github.com/lycheeverse/lychee-action. We can use this action to periodically check for broken links and also on PRs to make sure that it doesn't include broken links.
If you want to see am example of how this can be done, lychee docs are itself checked with lychee. See https://github.com/lycheeverse/lychee/blob/master/.github/workflows/links.yml
This has been opened up for discussion on recommendation in https://github.com/libuv/libuv/pull/3312#issuecomment-934743050
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
Review the proposed lychee setup and the example .github/workflows/links.yml from the lychee repository, along with the discussion in libuv PR #3312. Define the workflow's periodic and pull-request checks, then verify that the configured checks cover the documentation links without introducing broken-link failures.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100