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 bd990ae27..3e85ce157 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 @@ -1,4 +1,4 @@ ## 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 dff31470a..27b3e2a55 100644 --- a/fern/products/docs/pages/api-references/sdk-snippets.mdx +++ b/fern/products/docs/pages/api-references/sdk-snippets.mdx @@ -3,13 +3,7 @@ title: Display SDK snippets description: Enable SDK code examples in TypeScript, Python, Go, and more from the request and response examples documented in your API definition. Once enabled, Fern Docs will automatically populate the snippets within your API Reference. --- - When you use Fern's SDK Generator, you can automatically display SDK code snippets in your API Reference. These snippets are generated from your API definition examples and appear in a language selector dropdown, with cURL as the default option. - - - 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. - - To use dynamic snippets, [enable them in your `docs.yml`](/docs/configuration/site-level-settings#dynamic-snippets-configuration) and then complete the setup instructions on this page. - +When you use Fern's SDK Generator, you can automatically display SDK code snippets in your API Reference. These snippets are generated from your API definition examples and appear in a language selector dropdown, with cURL as the default option. SDK snippets are dynamic by default, allowing users to modify parameters and see code examples update in real time across all supported languages. ![SDK code snippet selector](https://fern-image-hosting.s3.amazonaws.com/sdk-code-snippets.png) diff --git a/fern/products/docs/pages/customization/site-level-settings.mdx b/fern/products/docs/pages/customization/site-level-settings.mdx index 03bbeafb3..dce43df1e 100644 --- a/fern/products/docs/pages/customization/site-level-settings.mdx +++ b/fern/products/docs/pages/customization/site-level-settings.mdx @@ -913,8 +913,8 @@ experimental: ai-example-style-instructions: "Use names and emails that are inspired by plants." ai-examples: false # Set to false to disable - # Dynamic SDK snippets (disabled by default) - dynamic-snippets: true + # Dynamic SDK snippets (enabled by default) + dynamic-snippets: false # Set to false to disable ``` @@ -925,8 +925,8 @@ experimental: Controls [AI-generated examples](/learn/docs/ai-features/ai-examples) for API Reference pages. AI examples are enabled by default and show realistic data instead of placeholder values like `"string"`. Manual examples in `x-fern-examples` or OpenAPI `example` properties always take priority. Set to false to disable AI examples entirely. - - 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 snippets instead.