chore: Add references to docs to make relative, not direct, references #328
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sarina
force-pushed
the
sarina/aspects-docs-refs
branch
from
8cd2057 to
e3a7d04
Compare
sarina
commented
Jun 7, 2025
bmtcril
approved these changes
Jun 9, 2025
Contributor
bmtcril
left a comment
bmtcril
left a comment
There was a problem hiding this comment.
Thanks for cleaning this up!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is part of a greater docs cleanup.
Usage of
:doc:is an antipattern. It is fragile and prone to breaking cross references when docs are moved or renamed.Usage of linking directly to rendered docs is an antipattern for the same reason, with a bonus drawback of the build won't fail when docs are moved or renamed.
Adding in
.. _reference:syntax to files and headings means cross-references can instead be made with the:ref:directive, which will (presuming the references themselves are not deleted or renamed) be more robust to docs refactorings.