Use relative URLs to our docs pages, instead of https://docs.renovatebot.com/

[HonkingGoose]

What would you like Renovate to be able to do?

Many of our internal documentation links are hard-coded to our documentation page domain. For example in docs/usage/config-presets.md:

- Browse [Renovate's default presets](https://docs.renovatebot.com/presets-default/) to find any that are useful to you

Using relative links ¹ would have the following benefits:

• Makes the documentation Markdown files self-referencing (which makes the published docs bundle on GitHub releases actually usable standalone, I hope)
• Makes it easier to preview the documentation when running mkdocs serve on the docs publishing repo, as you can click on all the internal links without being taken to the production server on https://docs.renovatebot.com/

If you have any ideas on how this should be implemented, please tell us here.

I'll need advice on how to make the changes in a safe way, and how to test my work before putting it live on the main repository. I'd like to avoid breaking the links while I'm working on this change if at all possible. 🙈

Edit: VS Code can now check if Markdown links are correct. Go to VS Code changelog v1.67, languages and scroll down to read about the new Markdown language features.

MkDocs manual about linking to pages

Is this a feature you are interested in implementing yourself?

Maybe

Footnotes

1. https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML/Creating_hyperlinks#absolute_versus_relative_urls ↩

[rarkins]

If we need to experiment to get it right, it's ok to have some temporarily broken links

[HonkingGoose]

I've done what I can for this issue. I'll let somebody else do the rest. 😉

[HonkingGoose]

Related issue and PR on the Renovate docs repository:

• Try MkDocs v1.5.0 link validation renovatebot.github.io#304
• chore: recommended link check strictness renovatebot.github.io#305

[renovate-release]

🎉 This issue has been resolved in version 37.76.0 🎉

The release is available on:

• GitHub release
• 37.76.0

Your semantic-release bot 📦🚀