Our documentation contains many links to internal pages and external websites. To ensure a good user experience, we need to regularly check that these links are not broken.
This task is to create a script (hack/verify-links.sh) that automatically checks for broken links in all Markdown (.md) files and integrate it into our existing verification pipeline. The main verification script (hack/verify-all.sh) could then be updated to execute hack/verify-links.sh. Running make verify should successfully run the link checker over all .md files in the repository.
We can use docs/book/install-and-build-mdbook.sh as a reference for how to download a tool based on OS and architecture. The lychee tool is a good option for this purpose.
example, ref: containerd project has this workflow
Our documentation contains many links to internal pages and external websites. To ensure a good user experience, we need to regularly check that these links are not broken.
This task is to create a script (
hack/verify-links.sh) that automatically checks for broken links in all Markdown (.md) files and integrate it into our existing verification pipeline. The main verification script (hack/verify-all.sh) could then be updated to executehack/verify-links.sh. Runningmake verifyshould successfully run the link checker over all.mdfiles in the repository.We can use
docs/book/install-and-build-mdbook.shas a reference for how to download a tool based on OS and architecture. Thelycheetool is a good option for this purpose.example, ref: containerd project has this workflow