Skip to content

fix: clarify within-collection vs cross-collection link conventions #246

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.

Sign up for GitHub

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

Merged
tuxmea merged 1 commit into from
May 23, 2026
+6 −4
Merged

fix: clarify within-collection vs cross-collection link conventions #246

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,9 @@ Use the following terms for the individual components:

### Linking

- Don't use URI for links pointing to files form this documentation
- Use URI when referring to remote locations
- Use absolute paths when pointing to files from other sections
- Use filename only without path when referring to a file in the same directory
- Within a versioned collection (e.g. `docs/_openvox_8x/`), use relative links (`page.html`)
rather than absolute `/openvox/latest/page.html` links. Absolute `/latest/` links silently
cross version boundaries when a new major version is added.
- Prefer `page.html` over `./page.html` — the leading `./` is unnecessary.
- When linking across collections (e.g. from `_openvox_8x/` to `_openvoxdb_8x/`), use absolute paths (`/openvoxdb/latest/page.html`).
- Use full URIs for external links only.