Skip to content

Link docs pages by file path from the docs root - #874

Open
lmac-1 wants to merge 2 commits into
mainfrom
absolute-links
Open

lmac-1 wants to merge 2 commits into
mainfrom
absolute-links

Conversation

@lmac-1

@lmac-1 lmac-1 commented Sep 25, 2026 •

Copy link
Copy Markdown
Collaborator

Short Description

Replaces relative links in docs/ (like ../deploy/portability.md) with file paths from the docs root (like /deploy/portability.md), to prepare the docs for translation. Relative links break the build as soon as one end is translated and the other isn't; docs-root paths work either way and are still the file links Docusaurus recommends.

Closes #867

Details

A script rewrote 111 links in 35 files. Only link targets changed, each on its original line. The second commit updates the house style in AGENTS.md and the translate skill to match, so agents stop writing relative links and the translate skill no longer rewrites them.

Worth checking:

  • The 2 links in migration/converting-triggers.md into versioned_docs/ can't be file links, so they go to /documentation/legacy/build/triggers.
  • The 2 relative links to adaptor pages in manage-projects/oauth.md are now /adaptors/... URLs, since file links only work within docs/.
  • Links when reading the docs repo on github.com: GitHub reads / as the repo root, so these links don't work when clicking through Markdown on GitHub. The site isn't affected.

Merge order: this overlaps with the Prettier PR #875, which reformats many of the same files. Merge this one first; #875 gets re-run afterwards rather than having its conflicts fixed by hand.

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to know!):

  • I have used Claude Code
  • I have used another model
  • I have not used AI

You can read more details in our Responsible AI Policy

Relative links like ../deploy/portability.md only resolve next to the
page they are on, so they break the build as soon as one end is
translated and the other is not. Paths from the docs root resolve in
the translated folder first and fall back to the English one.
@lmac-1 lmac-1 changed the title Replace relative .md links in docs/ with full paths Link docs pages by file path from the docs root Sep 25, 2026
@lmac-1
lmac-1 requested a review from josephjclark September 25, 2026 15:56

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Replace relative .md links in docs/ with paths from the docs root

1 participant