Skip to content

Commit 9a2f54a

Browse files
Documentation updates from Promptless
1 parent 51419fb commit 9a2f54a

File tree

3 files changed

+8
-0
lines changed

3 files changed

+8
-0
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ 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+
810
Fern's API Explorer allows users to make authenticated requests to your API without ever leaving your documentation.
911

1012
### Auto-populate with examples

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ When you use Fern's SDK Generator, you can automatically display SDK code snippe
77

88
<Note> Fern supports SDK snippets for TypeScript, Python, Ruby, Go, and .NET/C#. </Note>
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>
13+
1014
<Frame>
1115
![SDK code snippet selector](https://fern-image-hosting.s3.amazonaws.com/sdk-code-snippets.png)
1216
</Frame>

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ Some features (e.g. search) are disabled in the local development environment, i
4141
- Search
4242
- SEO (favicon, auto-generated meta tags, etc.)
4343
- Authentication
44+
- SDK snippet dropdowns
45+
- API Explorer (Try It buttons)
4446
</Note>
4547

4648
### Custom ports

0 commit comments

Comments
 (0)