FTorch icon indicating copy to clipboard operation
FTorch copied to clipboard

Add CI task to check for broken links in the docs

Open niccolozanotti opened this issue 9 months ago • 3 comments

As per @jwallwork23 suggestion, it could be useful to think of CI task to prevent broken links (especially Markdown internal links) to end up in the docs. See e.g. commit e97f424.

niccolozanotti avatar Mar 14 '25 13:03 niccolozanotti

One way to do this is with Sphinx, which I've used before, although that's not necessarily the best tool to use for FTorch.

joewallwork avatar Apr 08 '25 10:04 joewallwork

There's also this GitHub Action: https://github.com/gaurav-nelson/github-action-markdown-link-check.

joewallwork avatar Apr 08 '25 10:04 joewallwork

I looked at a couple of options as part of #356 but could not come to a satisfactory result. Will revisit when time allows - suggest tackling in hackathon.

jatkinson1000 avatar Apr 08 '25 12:04 jatkinson1000