-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Validate relative links with docs tests #28561
Labels
priority-3-medium
Default priority, "should be done" but isn't prioritised ahead of others
type:docs
Documentation
Comments
I don't know enough to work on this issue. @viceice if you want to work on this, please assign yourself to the issue. 😉 |
will start working on it today
|
This was referenced Apr 26, 2024
We also need to validate anchors, see |
|
🎉 This issue has been resolved in version 37.330.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
priority-3-medium
Default priority, "should be done" but isn't prioritised ahead of others
type:docs
Documentation
Describe the proposed change(s).
Creating this issue as asked by @viceice in this comment:
We should check if all relative links in our Markdown files (
*.md
) are correct, this makes sure that the published docs has working links. This check should be automated, via tests or configuration of existing tools.The
mkdocs
dependency in ourrenovatebot/renovatebot.github.io
repository already warns us about some bad link types, here's the relevant snippet: 1mkdocs
already warns about bad relative links, but we only see that warning output when we (or Renovate) create a new docs build in the docs repo... So that warning can't help you decide if a PR is good to merge. 🙃We have a
documentation.spec.ts
file that has some docs specific tests. I don't see code that tests for relative links?Footnotes
mkdocs.yml
config file onrenovatebot.github.io
repository ↩The text was updated successfully, but these errors were encountered: