Automatically check links in docs

[lorenyu]

Context

When we move or rename docs, it sometimes breaks links. Those are easy to miss. It'd be nice to have an automated way to check links.

[Shweta46]

I would like to work on this issue

[lorenyu]

@Shweta46 great! Do you have any ideas for how to check links in the docs?

[yoomlam]

Some options:

• https://github.com/tcort/markdown-link-check (https://blog.nolanemirot.com/posts/check_broken_links/)
• https://pypi.org/project/linkcheckmd
• https://github.com/dkhamsing/awesome_bot

[lorenyu]

first one looks promising, but looks like it might need some work to configure. does it work for checking relative paths within a repo? like we have a lot of links to other docs or files within the repo, but a link-checker that checks if links are proper URLs won't work

[yoomlam]

There's an option to specify the baseUrl, so I assume so:

baseUrl the base URL for relative links.

Options replacementPatterns and projectBaseUrl may also be helpful.

[lorenyu]

@anybodys implemented this #497