Skip to content

fix(docs): wrap x/<module> paths in backticks to fix MDX build - #4968

Merged
julienrbrt merged 1 commit into
mainfrom
fix/docs-mdx-module-jsx
Aug 7, 2026
Merged

fix(docs): wrap x/<module> paths in backticks to fix MDX build#4968
julienrbrt merged 1 commit into
mainfrom
fix/docs-mdx-module-jsx

Conversation

@albttx

@albttx albttx commented Aug 7, 2026

Copy link
Copy Markdown
Collaborator

Problem

yarn build (Docusaurus) fails with:

SyntaxError: Expected corresponding JSX closing tag for <module>. (1215:43)

MDX parses the unquoted <module> in plain-text prose as an unclosed JSX tag, aborting the client bundle compile.

Fix

Wrap the affected file-path snippets in inline code backticks so MDX treats them as text, not JSX:

  • "x/<module>/migrations/vN/"`x/<module>/migrations/vN/`
  • "x/<module>/module/module.go"`x/<module>/module/module.go`

Applied in both the current docs and the version-v29 copy of 03-CLI-Commands/01-cli-commands.md.

Verification

yarn build now completes: [SUCCESS] Generated static files in "build".

🤖 Generated with Claude Code

MDX parsed the unquoted <module> in plain text as an unclosed JSX tag,
breaking `yarn build` with "Expected corresponding JSX closing tag for
<module>". Wrapping the paths in inline code resolves it.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@albttx
albttx requested a review from a team as a code owner August 7, 2026 19:01
@netlify

netlify Bot commented Aug 7, 2026

Copy link
Copy Markdown

Deploy Preview for docs-ignite ready!

Name Link
🔨 Latest commit e4db33b
🔍 Latest deploy log https://app.netlify.com/projects/docs-ignite/deploys/6a762ca4821d4e0936f2b1b0
😎 Deploy Preview https://deploy-preview-4968--docs-ignite.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions Bot added component:docs Documentation additions or improvements. component:ci CI/CD workflow and automated jobs. component:configs labels Aug 7, 2026
@julienrbrt
julienrbrt merged commit 409c02f into main Aug 7, 2026
31 of 34 checks passed
@julienrbrt
julienrbrt deleted the fix/docs-mdx-module-jsx branch August 7, 2026 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component:ci CI/CD workflow and automated jobs. component:configs component:docs Documentation additions or improvements.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants