Skip to content

Fix broken relative links on release-notes index pages - #376

Merged
digitaldiina merged 3 commits into
mainfrom
375-fix-release-notes-relative-links
Aug 31, 2026
Merged

Fix broken relative links on release-notes index pages#376
digitaldiina merged 3 commits into
mainfrom
375-fix-release-notes-relative-links

Conversation

@digitaldiina

@digitaldiina digitaldiina commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fixes 333 broken relative links across 47 index.md/index.mdx files under release-notes/, converting them to root-relative absolute paths.
  • Corrects contribute/markdown-guide/links-in-docs.mdx's previously wrong guidance on how relative links resolve on index pages, and adds a <Warning> callout so this doesn't get reproduced.

Closes #375

Root cause

A page built from a literal index.md/index.mdx file is served at its folder's own bare path with no trailing slash (for example release-notes/12/index.mdx serves at /release-notes/12). Relative-URL resolution drops the last URL segment as if it were a filename, which is correct for a real leaf page but wrong here, since that segment is the folder itself. A link written as ./12/index on release-notes/index.mdx resolved to /12/index instead of /release-notes/12/index, a 404.

Full detail in #375.

Verification

  • Fix script validated all 333 rewritten targets resolve to a real file on disk before writing anything (0 unresolved).
  • markdownlint-cli2 on all 48 touched files: only pre-existing issues, confirmed identical to main's baseline for the same files (3 MD053 in release-notes/11/index.mdx, 1 MD053 in release-notes/mobile/index.mdx, 1 MD044 in release-notes/integrations/index.md), plus one documented MD053 false positive in the new <Warning> block (markdownlint doesn't scan inside HTML/JSX tags, already noted elsewhere in the same file).
  • mint validate: 13 warnings, all pre-existing and unrelated (generated mdo-providers/archive-providers xref/tag issues plus a .scratch/ file), none in the touched files.

Test plan

  • On the PR preview, click "version 12.2" from /release-notes and confirm it lands on /release-notes/12, not /12/index.
  • Spot-check a few other converted links (/release-notes/11, /release-notes/mobile, /release-notes/integrations) resolve correctly.

Bergfrid Dias added 2 commits August 31, 2026 09:20
Every relative link authored on an index.md/index.mdx file under
release-notes/ resolved to the wrong URL in production, since these
pages serve at their folder's own bare path with no trailing slash and
standard relative-URL resolution drops that last segment as if it were
a filename. Converted all 333 affected links (across 47 files) to
root-relative absolute paths, verified each target resolves to a real
file on disk.
The guide previously claimed a relative link authored on an index page
resolves against the folder containing that file. It actually resolves
against that folder's parent, since the page's own URL has no trailing
slash - the opposite of what was documented, and the root cause of the
release-notes 404s fixed in the previous commit. Added a Warning
callout and removed the now-incorrect "../index" example.
@mintlify

mintlify Bot commented Aug 31, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
superofficeas 🟢 Ready View Preview Aug 31, 2026, 7:33 AM

@digitaldiina digitaldiina added broken-link Triage: One or more links don't work or have the wrong target release-notes Subject matter: release notes for a new SuperOffice version labels Aug 31, 2026
@digitaldiina digitaldiina added this to the Post-launch improvements milestone Aug 31, 2026
@github-project-automation github-project-automation Bot moved this to 📥 Ready for review in Content Tasks Aug 31, 2026
@digitaldiina
digitaldiina merged commit 1557400 into main Aug 31, 2026
7 checks passed
@github-project-automation github-project-automation Bot moved this from 📥 Ready for review to ✔ Done in Content Tasks Aug 31, 2026
@digitaldiina
digitaldiina deleted the 375-fix-release-notes-relative-links branch August 31, 2026 07:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

broken-link Triage: One or more links don't work or have the wrong target release-notes Subject matter: release notes for a new SuperOffice version

Projects

Status: ✔ Done

Development

Successfully merging this pull request may close these issues.

Relative links on release-notes index pages resolve to wrong URL (404)

1 participant