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

Merged
devalog merged 3 commits into from
Jan 28, 2026
+16 −8
Merged

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
3 commits
Select commit Hold shift + click to select a range
7ea2c13
docs: update SDK snippets documentation to reflect dynamic snippets a…
fern-api[bot] Jan 6, 2026
4c20318
Merge branch 'main' of https://github.com/fern-api/docs into fern/dyn…
devalog Jan 27, 2026
a46cf41
clarify wording
devalog Jan 27, 2026
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
Expand Up @@ -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.


6 changes: 3 additions & 3 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 @@ -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).

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

<Frame>
Expand Down
8 changes: 8 additions & 0 deletions fern/products/docs/pages/changelog/2026-01-05.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,11 @@ The `<RunnableEndpoint>` 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.
Copy link
Contributor

@github-actions github-actions bot Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated


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).
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 @@ -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
```

<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 SDK snippets instead.
</ParamField>

Loading