Fix broken links in Markdown files #1996
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This also introduces markdown-link-check as a
pre-commit
hook to check broken links in the Markdown files of the repository. The hook has been set as manual to not interfere in the usual development workflow.For example, to check links in a specific file:
Or to check all the Markdown files in the repository:
We should not include this in the pull request workflow because link checking is flaky. Sometimes working links fail from GitHub hosts because websites block them. But we could potentially create a separate workflow that developers could trigger manually.