Skip to content
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.

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

docs: Detect broken links from docs to other places in repo #2609

Open
pokey opened this issue Jul 30, 2024 · 0 comments
Open

docs: Detect broken links from docs to other places in repo #2609

pokey opened this issue Jul 30, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@pokey
Copy link
Member

pokey commented Jul 30, 2024

When we use relative links in our docs that escape the docs folder, eg ../../../../../foo, we rewrite them to GitHub URIs of the given file in our Docusaurus transform. However, we don't detect if they're broken. We should look in the repo for the file and throw an error if it doesn't exist

@pokey pokey added the documentation Improvements or additions to documentation label Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant