StanfordBDHG / .github

Collection of default community health files, GitHub Action workflows, templates
https://biodesigndigitalhealth.stanford.edu
3 stars 2 forks source link

Add workflow to check markdown files for broken links #34

Closed vishnuravi closed 10 months ago

vishnuravi commented 10 months ago

Add workflow to check markdown files for broken links

:recycle: 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.

:gear: 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:

PSchmiedmayer commented 10 months ago

Thank you @vishnuravi, this looks great and is a great addition to the automated checks 👍