Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

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

Notes

  • This is a pre-existing issue on main introduced in commit 425f2c1 ("Update changelogs from fern repo")
  • The fix uses backslash escaping (\{ and \}), which is the standard MDX escape syntax
  • I was unable to fully test this locally by running fern docs dev to completion due to time constraints, so human verification of the rendered output is important

Session: https://app.devin.ai/sessions/1f3f25ab839e41ec8e1b9e0ead287b12
Requested by: [email protected] (@dannysheridan)

@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Contributor

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.

1 participant