Skip to content

docs: update SDK snippets documentation to reflect dynamic snippets as default #2980

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −12
Open

docs: update SDK snippets documentation to reflect dynamic snippets as default #2980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion fern/products/cli-api-reference/cli-changelog/2026-01-05.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.


8 changes: 1 addition & 7 deletions fern/products/docs/pages/api-references/sdk-snippets.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Note title="Dynamic 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.

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.
</Note>
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.

<Frame>
![SDK code snippet selector](https://fern-image-hosting.s3.amazonaws.com/sdk-code-snippets.png)
Expand Down
8 changes: 4 additions & 4 deletions fern/products/docs/pages/customization/site-level-settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

<ParamField path="experimental.ai-example-style-instructions" type="string" required={false} toc={true}>
Expand All @@ -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.
</ParamField>

<ParamField path="experimental.dynamic-snippets" type="boolean" required={false} default="false" toc={true}>
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.
<ParamField path="experimental.dynamic-snippets" type="boolean" required={false} default="true" toc={true}>
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.
</ParamField>


Loading