Skip to content

Commit 08e86cc

Browse files
committed
clarify dynamic snippets
1 parent 7545a94 commit 08e86cc

File tree

3 files changed

+13
-9
lines changed

3 files changed

+13
-9
lines changed

fern/products/docs/pages/api-references/api-explorer.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@ subtitle: Reduce "time to 200" by allowing users to make real calls to your API
55

66
<Tip>This feature is available on the Basic plan and above. [Contact us](https://buildwithfern.com/contact) to get set up.</Tip>
77

8-
<Warning>This feature is not available in preview mode. Try It buttons will not work when running docs in preview mode (`fern docs dev` or `fern generate --docs --preview`). API explorer requires full docs hosting infrastructure and will only work in published documentation.</Warning>
9-
108
Fern's API Explorer allows users to make authenticated requests to your API without ever leaving your documentation.
119

10+
<Warning>
11+
The API Explorer (**Try it** button) is not available when [previewing changes locally](/docs/preview-publish/previewing-changes-locally) (`fern docs dev` or `fern generate --docs --preview`) since this feature requires full docs hosting infrastructure.
12+
</Warning>
13+
1214
### Auto-populate with examples
1315
Fern will automatically populate the fields of the endpoint with the values set in your API specification.
1416

fern/products/docs/pages/api-references/sdk-snippets.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,9 @@ description: Enable SDK code examples in TypeScript, Python, Go, and more from t
55

66
When you use Fern's SDK Generator, you can automatically display SDK code snippets in your API Reference. These snippets appear in a language selector dropdown, with cURL as the default option.
77

8-
<Note> Fern supports SDK snippets for TypeScript, Python, Ruby, Go, and .NET/C#. </Note>
8+
These snippets are generated from your API definition examples. Alternatively, dynamic snippets allow users to modify parameters and see code examples update in real time. To enable dynamic snippets, complete the setup instructions on this page and then [contact us](https://buildwithfern.com/contact).
99

10-
<Warning>
11-
The snippets dropdown for different SDKs will not be available when you are running your docs in [preview mode](/learn/docs/preview-mode) (`fern docs dev` or `fern generate --docs --preview`). This is the expected behavior since these features require our full docs hosting infrastructure. Reach out to us if you'd like to enable dynamic snippets for more languages, so these snippets work during local development.
12-
</Warning>
10+
<Note>Fern supports SDK snippets for TypeScript, Python, Ruby, Go, and .NET/C#. [Contact us](https://buildwithfern.com/contact) if you need support for more languages. </Note>
1311

1412
<Frame>
1513
![SDK code snippet selector](https://fern-image-hosting.s3.amazonaws.com/sdk-code-snippets.png)
@@ -114,7 +112,11 @@ navigation:
114112
115113
### Trigger generation
116114
117-
As the final step, trigger your docs generation by running `fern generate --docs` locally or in CI/CD (i.e., GitHub Actions). The SDK snippets will now appear via a drop-down!
115+
As the final step, trigger your docs generation by running `fern generate --docs` locally or in CI/CD (i.e., GitHub Actions). The SDK snippets will now appear via a dropdown!
116+
117+
<Warning>
118+
The snippets dropdown is not available when [previewing changes locally](/docs/preview-publish/previewing-changes-locally) (`fern docs dev` or `fern generate --docs --preview`) since this feature requires full docs hosting infrastructure. Dynamic snippets are available in preview mode.
119+
</Warning>
118120

119121
### Set default snippet language
120122

fern/products/docs/pages/getting-started/preview-changes-locally.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ fern docs dev
3737
A local preview of your documentation will be available at `http://localhost:3000`. The functionality is available offline if you have run local development mode online at least once.
3838

3939
<Note>
40-
Some features (e.g. search) are disabled in the local development environment, including:
40+
Some features are disabled in the local development environment, including:
4141
- Search
4242
- SEO (favicon, auto-generated meta tags, etc.)
4343
- Authentication
4444
- SDK snippet dropdowns
45-
- API Explorer (Try It buttons)
45+
- API Explorer (**Try It** buttons)
4646
</Note>
4747

4848
### Custom ports

0 commit comments

Comments
 (0)