Skip to content

docs(mermaid): Prevent browser translation from breaking diagrams#18834

Open
sentry[bot] wants to merge 2 commits into
masterfrom
seer/fix/docs-mermaid-translation
Open

docs(mermaid): Prevent browser translation from breaking diagrams#18834
sentry[bot] wants to merge 2 commits into
masterfrom
seer/fix/docs-mermaid-translation

Conversation

@sentry

@sentry sentry Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.
This PR addresses issue DOCS-AV9 where browser translation extensions (like Google Translate) were corrupting Mermaid diagram syntax, leading to UnknownDiagramError.

The root cause was identified as the Mermaid diagram source text being rendered in a div without explicit instructions to translation extensions to ignore its content. This allowed extensions to translate keywords like graph LR into other languages (e.g., 流程图 LR), making the diagram unparseable by Mermaid.

To fix this, translate="no" and className="notranslate" attributes have been added to the Mermaid wrapper div in src/components/codeBlock/index.tsx. This signals to translation extensions that the content of this specific div should not be translated, preserving the original Mermaid syntax.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Fixes DOCS-AV9

Comment @sentry <feedback> on this PR to have Autofix iterate on the changes.

@vercel

vercel Bot commented Jul 25, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview Jul 25, 2026 10:51am
sentry-docs Ready Ready Preview Jul 25, 2026 10:51am

Request Review

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.

0 participants