fix: clarify within-collection vs cross-collection link conventions#246
Merged
tuxmea merged 1 commit intoMay 23, 2026
Merged
Conversation
Closes OpenVoxProject#245 Replace the ambiguous "Use absolute paths when pointing to files from other sections" with explicit guidance distinguishing: - Within a versioned collection: use relative links to avoid silently crossing version boundaries when a new major version is added - Across collections: use absolute paths Signed-off-by: Michael Harp <mike@mikeharp.com>
tuxmea
approved these changes
May 23, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes #245
Summary
Replaces the ambiguous "Use absolute paths when pointing to files from other sections" with explicit guidance that distinguishes two distinct cases:
docs/_openvox_8x/): use relative links (page.html). Absolute/latest/links silently cross version boundaries when a new major version is added._openvox_8x/→_openvoxdb_8x/): use absolute paths (/openvoxdb/latest/page.html). This matches existing practice throughout the docs.Also adds the
./page.html→page.htmlpreference noted in the issue.Test plan