fix: escape <String> in Java changelog MDX to fix docs validation#4372
Closed
davidkonigsberg wants to merge 2 commits into
Closed
fix: escape <String> in Java changelog MDX to fix docs validation#4372davidkonigsberg wants to merge 2 commits into
<String> in Java changelog MDX to fix docs validation#4372davidkonigsberg wants to merge 2 commits into
Conversation
Co-Authored-By: David Konigsberg <davidakonigsberg@gmail.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
Co-Authored-By: David Konigsberg <davidakonigsberg@gmail.com>
Contributor
Author
|
fixed a different way |
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
1 participant
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.
Summary
The docs build was failing because
<String>in the Java SDK changelog entry (2026-03-18.mdx, line 44) was being parsed as an unclosed HTML/JSX tag by the MDX compiler.Fixed by wrapping
onMessage(Consumer<String>)in backticks, which is also more consistent with how other code references in the same file are formatted.CI error:
Failed to parse products/sdks/overview/java/changelog/2026-03-18.mdx: Expected a closing tag for <String> (44:29-44:37) before the end of strongReview & Testing Checklist for Human
Link to Devin session: https://app.devin.ai/sessions/cfc4d746f9814cd9944225c7ede073da
Requested by: @davidkonigsberg