libuv icon indicating copy to clipboard operation
libuv copied to clipboard

Periodically checking external links in documentation

Open thunder-coding opened this issue 4 years ago • 1 comments

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

thunder-coding avatar Oct 08 '21 02:10 thunder-coding

This issue has been automatically marked as stale because it has not had recent activity. Thank you for your contributions.

stale[bot] avatar Jan 09 '22 02:01 stale[bot]