Skip to content

๐Ÿž๐Ÿ”ง๏ผšmake cross-document links absolute - #884

Merged
OpenINFbot merged 1 commit into
mainfrom
fix/absolute-cross-document-links
Aug 10, 2026
Merged

๐Ÿž๐Ÿ”ง๏ผšmake cross-document links absolute#884
OpenINFbot merged 1 commit into
mainfrom
fix/absolute-cross-document-links

Conversation

@DerekNonGeneric

Copy link
Copy Markdown
Member

Pull Request Purpose

This PR contains the following:

  • ๐Ÿž๐Ÿ”ง bugfixing (๐Ÿœ/๐ŸฆŸ/๐Ÿ›/๐Ÿฆ—/๐Ÿ et al.)
  • ๐Ÿ†•๐ŸŽ implementation of new feature(s)
  • โ™ป๏ธ refactoring(s)
  • ๐Ÿ“„ documentation modification(s)
  • ๐Ÿ”ฎ other

Testing

  • yes (bugfixes and features will not be merged without tests)
  • no

Link reference definitions in Markdown; no code path to cover. Every replacement URL was checked to return 200.

Breaking Changes

  • yes (breaking changes will not be merged unless necessary)
  • no

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.md resolves against that URL and 404s.

Absolute URLs work in both places. README.md already writes its self-references as https://github.com/OpenINF/.github/blob/HEAD/โ€ฆ, so this follows the convention already in the repo rather than inventing one.

file was now
SUPPORT.md ./CODE_OF_CONDUCT.md โ€ฆ/blob/HEAD/CODE_OF_CONDUCT.md
CONTRIBUTING.md ./CODE_OF_CONDUCT.md โ€ฆ/blob/HEAD/CODE_OF_CONDUCT.md
CONTRIBUTING.md ./README.md โ€ฆ/blob/HEAD/README.md
CONTRIBUTING.md ./SECURITY.md โ€ฆ/blob/HEAD/SECURITY.md
CONTRIBUTING.md ./LICENSE.md โ€ฆ/tree/HEAD/LICENSE

Note

That last row is a bug that predates this change and is broken in every context, including on GitHub. The prose in CONTRIBUTING.md says:

located within the [`LICENSE`][] folder in the root directory of the repository.

โ€ฆ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, when LICENSE is a directory holding MIT.txt, Apache-2.0.txt, and BlueOak-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

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>
@OpenINFbot OpenINFbot changed the title ๐Ÿž๐Ÿ”ง Make cross-document links absolute ๐Ÿž๐Ÿ”ง๏ผšmake cross-document links absolute Aug 10, 2026
@OpenINFbot
OpenINFbot merged commit 991e5d6 into main Aug 10, 2026
4 of 6 checks passed
@OpenINFbot
OpenINFbot deleted the fix/absolute-cross-document-links branch August 10, 2026 00:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants