fix(docs): escape curly braces in CLI changelog to fix MDX parse error #2056
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.
fix(docs): escape curly braces in CLI changelog to fix MDX parse error
Summary
Fixes an MDX parse error in the CLI changelog that was causing documentation builds to fail with "Could not parse expression with acorn". The issue was caused by unescaped curly braces in
{API name}which MDX interprets as a JavaScript expression. Since "API name" contains a space, it's invalid JavaScript and causes the parser to fail.The fix escapes the braces as
\{API name\}so they render as literal text instead of being interpreted as an expression.Context: This issue is blocking PR #2055 (AsyncAPI retry extension docs) from passing CI, as the parse error occurs during the docs build step even though that PR doesn't touch this file.
Review & Testing Checklist for Human
{API name}correctly as literal text (not as a broken expression or missing text)Notes
\{and\}), which is the standard MDX escape syntaxfern docs devto completion due to time constraints, so human verification of the rendered output is importantSession: https://app.devin.ai/sessions/1f3f25ab839e41ec8e1b9e0ead287b12
Requested by: [email protected] (@dannysheridan)