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 test to validate broken links in markdown files #4342

Open

sudanl0 opened this issue Dec 22, 2023 · 1 comment

Contributor

sudanl0 commented Dec 22, 2023

We have lot of links in our md files which are broken and could be broken due to refactoring of code.
We need to add a new CI test which checked for all the links in all the md files in the repo.
The discussion started with #4341 (comment)
and we found mlc which can validate all links in the md files however it fails to validate links that are embedded like https://github.com/firecracker-microvm/firecracker/blob/main/docs/getting-started.md?plain=1#L79

The new test should cover links in all md files (embedded in code or not).

sudanl0 mentioned this issue

doc(metrics): Make metrics related info easily accessible #4341

Merged

5 tasks

sudanl0 mentioned this issue

test: add a test to check for correct internal links, and fix them #4421

Merged

9 tasks

Contributor

andr3wy commented Apr 3, 2024

Hi everyone,

We're a group at UT Austin and we're interested in picking this issue up.

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