Add workflow to check markdown files for broken links #34
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vishnuravi
changed the title
Signed-off-by: Paul Schmiedmayer <[email protected]>
Signed-off-by: Paul Schmiedmayer <[email protected]>
PSchmiedmayer
approved these changes
Oct 29, 2023
|
Thank you @vishnuravi, this looks great and is a great addition to the automated checks 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add workflow to check markdown files for broken links
♻️ Current situation & Problem
@StanfordBDHG and @StanfordSpezi repositories have markdown files with many external links, including Swift Package Index documentation and others. It is cumbersome to manually ensure that all links in markdown files are working and frustrating for users who encounter broken links.
⚙️ Release Notes
Adds a workflow that can be used to check a repository's markdown files for broken links using markdown-link-check.
Code of Conduct & Contributing Guidelines
By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines: