๐๐ง๏ผmake cross-document links absolute - #884
Merged
Conversation
These documents are read well outside this repository โ GitHub renders them as the org's community health files, and openinf.github.io imports SUPPORT.md and friends as pages under /docs. A link written as ./CODE_OF_CONDUCT.md only resolves in the first context; as a page at /docs/dev/faq/support/ it resolves against that URL and 404s. Absolute URLs work in both places, and README.md already writes its self-references this way, so this follows what is already here rather than introducing a new convention. Two of these were broken before this change regardless of context: the prose refers to [`LICENSE`][] while the only definition was [`LICENSE.md`], leaving the reference unresolved and the definition orphaned, and it pointed at ./LICENSE.md when LICENSE is a directory of license texts. The label now matches the prose and points at that directory. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This was referenced Aug 10, 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
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.
Pull Request Purpose
This PR contains the following:
Testing
Link reference definitions in Markdown; no code path to cover. Every replacement URL was checked to return
200.Breaking Changes
Description
These documents get read well outside this repository. GitHub surfaces them as the organization's community health files, and openinf.github.io imports five of them as pages under
/docs. A repository-relative link only resolves in the first context โ rendered at/docs/dev/faq/support/,./CODE_OF_CONDUCT.mdresolves against that URL and 404s.Absolute URLs work in both places.
README.mdalready writes its self-references ashttps://github.com/OpenINF/.github/blob/HEAD/โฆ, so this follows the convention already in the repo rather than inventing one.SUPPORT.md./CODE_OF_CONDUCT.mdโฆ/blob/HEAD/CODE_OF_CONDUCT.mdCONTRIBUTING.md./CODE_OF_CONDUCT.mdโฆ/blob/HEAD/CODE_OF_CONDUCT.mdCONTRIBUTING.md./README.mdโฆ/blob/HEAD/README.mdCONTRIBUTING.md./SECURITY.mdโฆ/blob/HEAD/SECURITY.mdCONTRIBUTING.md./LICENSE.mdโฆ/tree/HEAD/LICENSENote
That last row is a bug that predates this change and is broken in every context, including on GitHub. The prose in
CONTRIBUTING.mdsays:โฆbut the only definition was
[`LICENSE.md`]. The labels don't match, so the reference never resolved and the definition sat orphaned โ and it pointed at./LICENSE.md, whenLICENSEis a directory holdingMIT.txt,Apache-2.0.txt, andBlueOak-1.0.0.txt. The label now matches the prose and points at that directory. Happy to split this into its own PR if you'd rather keep this one to the relativeโabsolute change.Why now
openinf.github.io validates its built pages with the W3C validator, and a fix there stops its import from rewriting your prose to make the links work. Keeping these links portable at the source means that site โ and any other consumer โ needs no such rewriting.
Follows #883.
List of any relevant issue numbers: none