Closed vil02 closed 5 months ago
Is there an (easy) option to make it fail if there are more broken links than there were before, though?
I am not aware of an easy way. But I also think this is not the right way to go. One can split these broken links into three groups:
implementations
-section: you suggested to remove these sections,Two first groups are quite easy to fix (the second one just needs a guideline, so all of the formulas will be written in an uniform way). And I think there are not that many in the 3rd. I would suggest no broken links policy.
I am not aware of an easy way. But I also think this is not the right way to go.
Well, the idea was that if someone opens a PR, we would like for CI to check whether they are introducing any new broken links.
Two first groups are quite easy to fix (the second one just needs a guideline, so all of the formulas will be written in an uniform way). And I think there are not that many in the 3rd. I would suggest no broken links policy.
Yes, I agree. Though the policy should probably be "no broken links, and try to use permanent links (such as archive.org) that are unlikely to break". Most links were probably not broken when they were added, but broke later on.
I've opened a PR to update our policy.
Description
Related to #154. This PR adds a workflow checking all links in the markdown files.
There are too many broken links to fix them at once. I decided to change the workflow in such a way, that (temporary) it will not fail when broken links are found.
Checklist
Screenshots (if any)
Note to reviewers
Adds a workflow checking links.