This repository has been archived by the owner on Jan 29, 2024. It is now read-only.
Use Sphinx :doc:
roles for links to docs.aiven.io documents
#1548
Labels
maintenance
maintenance tasks for the documentation
website
Related to the website or other implementation
We used to have to be more cautious about using
:doc:
because Vale would spell check the document names.Now that's not an issue, we could look for all the
https://docs.aiven.io
links and consider converting them to:doc:
links.Why is this worth doing? Mainly because it makes it clearer that the links are into our own documentation. It also reduces the length of the link, making it easier to read the source text.
The text was updated successfully, but these errors were encountered: