-
Notifications
You must be signed in to change notification settings - Fork 268
Open
Description
Which Fern component?
Fern Docs
How urgent is this?
P2 - Medium (Would be helpful)
What's the issue?
Steps to reproduce:
- Create a webhook definition in Fern Definition. Add a named example for the webhook that contains a $ inside a string (eg. "$3.00").
- Look at the Fern site (local, preview, or production site, it occurs in all three).
Expected behavior:
The named example renders with the "$3.00" as an example value.
Actual behavior
Site preview breaks with: Failed to read docs configuration. Rendering last successful configuration. [docs]: Failed to resolve examples
Environment details
MacOs Tahoe, Chrome, when running fern docs dev. Has been occurring with many versions of the Fern CLI, but I'm currently on 0.121.0.
Fern CLI & Generator Versions
Fern CLI version: 0.121.0 (but has been occurring since before 0.85.0 as far as I know.
Workaround
Judah discovered that you can remove the quotes and escape the $ symbol:
TotalAmount: \$3.00
renders in the example, but introduces opportunity for confusion and doc drift in our Fern definition.
Are you interested in contributing a fix?
No
Metadata
Metadata
Assignees
Labels
No labels