Skip to content

Fix broken internal markdown links in docs renderer#198

Open
JGPliskin wants to merge 1 commit intoshareAI-lab:mainfrom
JGPliskin:fix/docs-md-links
Open

Fix broken internal markdown links in docs renderer#198
JGPliskin wants to merge 1 commit intoshareAI-lab:mainfrom
JGPliskin:fix/docs-md-links

Conversation

@JGPliskin
Copy link
Copy Markdown

Summary

Fix broken internal markdown links in the docs site.

Markdown links such as ./glossary.md were being rendered as raw relative hrefs, which caused broken URLs like:

/zh/docs/s00-architecture-overview/glossary.md

instead of routing to the app's actual doc pages.

Cause

The markdown renderer converted markdown content to HTML, but did not rewrite internal .md links to the site's route structure.

Fix

Update the docs renderer to map internal markdown links using the generated docs index:

  • bridge docs -> /{locale}/docs/{slug}
  • chapter docs -> /{locale}/{version}

This keeps the markdown source unchanged while fixing navigation at render time.

Validation

  • Reproduced the broken link locally
  • Ran npm run build successfully
  • Confirmed generated output no longer contains raw internal .md hrefs for site docs

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 8, 2026

@JGPliskin is attempting to deploy a commit to the crazyboym's projects Team on Vercel.

A member of the Team first needs to authorize it.

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