Skip to content

Commit 285e5ad

Browse files
authored
Merge pull request #246 from miharp/fix/contributing-link-conventions
fix: clarify within-collection vs cross-collection link conventions
2 parents b533026 + 56278bd commit 285e5ad

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,9 @@ Use the following terms for the individual components:
8989

9090
### Linking
9191

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

0 commit comments

Comments
 (0)