Repository navigation
fix: repair MDX-breaking angle brackets in generated SDK docs - #189
Merged
Merged
Conversation
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CRtqyLrN6mf5oEw5ujRqaH
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
mainbuild fails since #187 (SyntaxError: Expected corresponding JSX closing tag for <schema>/<i>/<seq>/<SecretString>/<Link>/<label>in 7docs/sdk/clients/*.mdfiles).Cause:
sdk-jsgenerated docs now contain<placeholder>split out of inline code (```List<Link>`` ``) and barep`, which `scripts/update-sdk-docs.sh` didn't handle (single-letter names like `` were treated as real HTML tags).Fix
scripts/update-sdk-docs.sh:List`<T>`` `` →List<x>already inside an inline code span<i>,<b>, …) as HTML only if a closing tag is on the same lineRegenerated affected docs (8 files, 1-12 lines each).
Test plan
mainwith@mdx-js/mdx@1+ babel JSX parse; 0 failures on all 112 sdk/cli docs after fixNote: root cause is upstream in the
sdk-jsdoc generator; this makes the docs build resilient.Generated by Claude Code