New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add links check for markdown files in sanity tests #586

Closed

shivamshriwas opened this issue Aug 4, 2020 · 0 comments · Fixed by #584

Assignees

Contributor

shivamshriwas commented Aug 4, 2020 •

edited

Loading

Context :
Currently, there is no automated check to identify and flag broken links in documentation.

Proposed enhancement:

Add checks in sanity script to test all links in markdown files are valid.
Sanity script should return failure if broken links are found in any of the markdown files.
types possible of links in .md files:
- URLs
- links to other folders/files/images

shivamshriwas self-assigned this

shivamshriwas linked a pull request

that will close this issue

[WIP] Documentation fixes and enhancements #584

Merged

2 tasks

maaquib closed this as completed in #584

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment