diff --git a/fern/products/cli-api-reference/cli-changelog/2026-01-05.mdx b/fern/products/cli-api-reference/cli-changelog/2026-01-05.mdx index 119598722..8df506558 100644 --- a/fern/products/cli-api-reference/cli-changelog/2026-01-05.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2026-01-05.mdx @@ -3,6 +3,6 @@ ## 3.34.0 -**`(feat):`** Updates the SDK snippet generation to use dynamic snippets by default. To disable, set `experimental.dynamicSnippets` to `false` in your `docs.yml` file. +**`(feat):`** Updates the SDK snippet generation to use dynamic snippets by default. To disable, set `experimental.dynamic-snippets` to `false` in your `docs.yml` file. diff --git a/fern/products/docs/pages/api-references/sdk-snippets.mdx b/fern/products/docs/pages/api-references/sdk-snippets.mdx index 329870c0f..8b00092dc 100644 --- a/fern/products/docs/pages/api-references/sdk-snippets.mdx +++ b/fern/products/docs/pages/api-references/sdk-snippets.mdx @@ -5,12 +5,12 @@ description: Enable SDK code examples in TypeScript, Python, Go, and more from t If you use Fern to generate SDKs, you can display SDK code snippets in your API Reference. These snippets show examples using your actual SDK in TypeScript, Python, Go, and other supported languages. -When configured, SDK snippets are shown by default, replacing [HTTP snippets](/learn/docs/api-references/http-snippets). +Once configured, SDK snippets replace [HTTP snippets](/learn/docs/api-references/http-snippets). - By default, SDK snippets are static code examples. Alternatively, you can use dynamic SDK snippets that allow users to modify parameters and see code examples update in real time. + By default, SDK snippets are dynamic code examples that allow users to modify parameters and see code examples update in real time across all supported languages. - To use dynamic snippets, [enable them in your `docs.yml`](/learn/docs/configuration/site-level-settings#experimentaldynamic-snippets) and then complete the setup instructions on this page. + Alternatively, you can [disable dynamic snippets in your `docs.yml`](/learn/docs/configuration/site-level-settings#experimentaldynamic-snippets) and use static code examples. diff --git a/fern/products/docs/pages/changelog/2026-01-05.mdx b/fern/products/docs/pages/changelog/2026-01-05.mdx index afc2c62a3..71c8b1285 100644 --- a/fern/products/docs/pages/changelog/2026-01-05.mdx +++ b/fern/products/docs/pages/changelog/2026-01-05.mdx @@ -9,3 +9,11 @@ The `` component now supports a `collapsed` prop to control th This is useful for embedding multiple endpoints on a page or reducing visual clutter while maintaining interactive API testing. Learn more about the [Runnable Endpoint](/learn/docs/writing-content/components/runnable-endpoint) component. + +## Dynamic SDK snippets enabled by default + +Dynamic SDK snippets are now enabled by default. When you configure SDK snippets, users can modify parameters and see code examples update in real time across all supported languages. + +If you prefer static code examples, you can [disable dynamic snippets](/learn/docs/configuration/site-level-settings#experimentaldynamic-snippets) in your `docs.yml`. + +Learn more about [SDK snippets](/learn/docs/api-references/sdk-snippets). diff --git a/fern/products/docs/pages/customization/site-level-settings.mdx b/fern/products/docs/pages/customization/site-level-settings.mdx index 348ffb03c..064d841d6 100644 --- a/fern/products/docs/pages/customization/site-level-settings.mdx +++ b/fern/products/docs/pages/customization/site-level-settings.mdx @@ -927,11 +927,11 @@ Configure experimental features in the `experimental` section of your `docs.yml` ```yaml docs.yml experimental: - # Dynamic SDK snippets (disabled by default) - dynamic-snippets: true + # Dynamic SDK snippets (enabled by default) + dynamic-snippets: false # Set to false to disable ``` - - Enables dynamic SDK snippets that allow users to modify parameters and see code examples update in real time. When enabled, follow the [SDK snippets setup instructions](/docs/api-references/sdk-snippets) to configure. + + Controls dynamic SDK snippets that allow users to modify parameters and see code examples update in real time. Dynamic snippets are enabled by default and supported across all languages. Follow the [SDK snippets setup instructions](/docs/api-references/sdk-snippets) to configure. Set to false to use static SDK snippets instead.