Skip to content

docs: convert hardcoded internal URLs to validated relative links - #834

Merged
jaredlockhart merged 1 commit into
mainfrom
fix-hardcoded-internal-links
Jul 27, 2026
Merged

docs: convert hardcoded internal URLs to validated relative links#834
jaredlockhart merged 1 commit into
mainfrom
fix-hardcoded-internal-links

Conversation

@jaredlockhart

Copy link
Copy Markdown
Contributor

Because

  • Internal links written as fully-qualified https://experimenter.info/... URLs bypass Docusaurus's broken-link validation (onBrokenLinks: "throw"), because any link with a scheme+host is treated as external and never checked. Several had rotted to 404s after a docs restructure and shipped silently.
  • One link on the For Engineers page was relative without a leading slash, so it resolved against the page slug instead of the site root.

This commit

  • Converts all same-site fully-qualified links to root-relative internal paths, remapping stale paths to their current slugs so destinations are preserved.
  • Fixes the missing-leading-slash relative link on the For Engineers page.
  • Leaves genuinely external links and non-link experimenter.info strings (display text, an FML YAML example, the site url config) untouched.
  • npm run build passes with onBrokenLinks: "throw", so these links are now covered by validation and future rot fails the build.

Because

* Same-site links written as fully-qualified https://experimenter.info/...
  URLs are treated as external by Docusaurus, so onBrokenLinks:"throw"
  never validated them and many had rotted to stale flat paths from an
  old docs structure.
* One relative link in getting-started/for-engineers.md was missing its
  leading slash, so it resolved against the page slug instead of the site
  root and 404'd.

This commit

* Rewrites every same-site fully-qualified link to its current
  root-relative slug, preserving anchors.
* Adds the missing leading slash on the web-integration link.
@jaredlockhart
jaredlockhart marked this pull request as ready for review July 27, 2026 17:20
@jaredlockhart
jaredlockhart merged commit 9925c3e into main Jul 27, 2026
2 checks passed
@jaredlockhart
jaredlockhart deleted the fix-hardcoded-internal-links branch July 27, 2026 17:20
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.

1 participant