Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/api-def/openapi-pages/extensions/ignore.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Ignoring elements
description: Skip reading endpoints, schemas, properties, or parameters using the `x-fern-ignore` extension
description: Use x-fern-ignore to exclude endpoints, schemas, properties, or parameters from your OpenAPI spec. Control what Fern reads and processes.
---

If you want Fern to skip reading any endpoints, schemas, properties, or parameters, use the `x-fern-ignore` extension.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/api-def/openapi-pages/webhooks.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Webhooks
subtitle: Define webhooks using OpenAPI 3.1+ native webhook support or Fern's extensions
description: Learn how to define webhooks using OpenAPI 3.1 native support or Fern's extensions. Generate webhook docs and SDK verification utilities.
---

Fern supports two methods for defining webhooks in your OpenAPI specification:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: SDK group names
description: Group related methods in the SDK using `x-fern-sdk-group-name` extension
description: Learn how to use x-fern-sdk-group-name in OpenRPC to organize related methods into logical groups for cleaner, more intuitive SDK code.
---

Group related methods in the SDK:
Expand Down
2 changes: 1 addition & 1 deletion fern/products/api-def/openrpc-pages/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: What is an OpenRPC specification?
description: OpenRPC is a standard for documenting JSON-RPC APIs
description: Learn how to use OpenRPC specifications with Fern to document JSON-RPC APIs. Set up your fern folder and configure OpenRPC v1.3.2 or v1.2.6.
---

<Markdown src="/snippets/enterprise-plan.mdx"/>
Expand Down
3 changes: 1 addition & 2 deletions fern/products/ask-fern/pages/features/analytics.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Analytics
description: View usage metrics and conversation details from Ask Fern queries on your
documentation site.
description: Track Ask Fern analytics with query and conversation data. View user interactions, export to CSV, and optimize your documentation strategy.
---

The Ask Fern tab of the [Fern Dashboard](http://dashboard.buildwithfern.com) displays queries and conversations per day on your documentation site. You can view data by week, month, year, or all-time periods.
Expand Down
4 changes: 1 addition & 3 deletions fern/products/ask-fern/pages/features/guidance.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Guidance
subtitle: Fine-tune your Ask Fern responses.
description: Configure custom guidance to override Ask Fern AI responses for specific queries. Control sensitive content like billing and legal terms.
---

## Overview

You can add custom guidance to "override" Ask Fern's responses to specific user queries. This is useful for content that you
may not want to display explicitly in your documentation, such as billing information, legal terms, and other sensitive content.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: What is Ask Fern?
description: Let your customers find answers in your documentation instantly.
description: Ask Fern is an AI search feature that indexes your documentation and helps users find answers instantly. Reduce support burden and accelerate onboarding.
---

Ask Fern is Fern's AI Search feature that indexes your documentation and provides an interface for your end users to ask questions and get answers. It appears as a side panel on your documentation site so users can ask questions without leaving the page.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/docs/pages/ai/ai-examples.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: AI-generated examples
description: Automatically generate realistic API examples from your OpenAPI spec
description: Automatically create realistic API examples with Fern's AI feature. Customize example styles or disable AI generation as needed.
---

Fern uses AI to automatically generate realistic request and response examples for your [API Reference](/learn/docs/api-references/generate-api-ref) documentation. This feature is enabled by default for all API Reference pages. Instead of placeholder values like `username: "string"`, you get believable data that reflects your endpoint properties and descriptions. Examples update automatically as your spec changes.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/docs/pages/ai/llms-txt.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: llms.txt and llms-full.txt
description: Enable tools like Cursor, GitHub Copilot, ChatGPT, and Claude to understand your documentation.
description: Fern automatically creates llms.txt files for AI developer tools. Filter by language, control visibility, and track analytics for LLM traffic.
---

[llms.txt](https://llmstxt.org/) is a standard for exposing website content to AI developer tools. Fern automatically generates and maintains `llms.txt` and `llms-full.txt` files for your documentation site.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/docs/pages/ai/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: AI features
description: Built-in AI features that help users find answers and help your team maintain documentation
description: Fern AI features help users find answers instantly, automate content updates, and optimize documentation for AI tools with llms.txt and MCP server support.
---
Your documentation site comes with automatic optimizations for AI tools, plus features you can install to help users find answers and keep your content up to date.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Write Markdown content in your API Reference
description: Add Markdown content to your API Reference including summary pages and content between endpoints.
description: Write rich Markdown content in API documentation. Add descriptions to endpoints, create summary pages, and customize your API Reference layout.
---

Fern Docs allows you to write Markdown content in your API Reference documentation. This feature is useful for providing additional context, examples, or explanations for your API endpoints.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Autopopulate API keys
subtitle: Make integrating with your API frictionless by adding your login flow to the API Explorer.
subtitle: Set up API key injection with JWT or OAuth authentication. Allow users to login and automatically populate their API keys in your API Explorer.
---

<Markdown src="/snippets/pro-plan.mdx"/>
Expand Down
2 changes: 1 addition & 1 deletion fern/products/docs/pages/authentication/sso.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Single Sign-On
subtitle: Enterprise authentication for secure access to your docs
subtitle: Fern SSO enables enterprise teams to access documentation securely using corporate credentials. Supports SAML 2.0 and OIDC protocols.
---

<Markdown src="/snippets/enterprise-plan.mdx"/>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Custom React Components
subtitle: Add your own React components to enhance your docs
title: Custom React components
description: Add custom React components to your Fern docs for interactive, server-rendered elements. Improve SEO, performance, and user experience with reusable components.
---

<Markdown src="/snippets/pro-plan.mdx"/>
Expand All @@ -12,7 +12,7 @@ This allows you to create unique, interactive elements that match your documenta
Don't use a React component to define a constant. Instead, consider using [reusable snippets](/docs/writing-content/reusable-snippets).
</Note>

## How does it work?
## How it works

<Steps>
### Create a React component
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Aside'
description: 'Push any content inside the Aside component to the right of the page in a sticky container'
title: Aside
description: Use Fern's Aside component to add floating, sticky content to your documentation pages. Ideal for showcasing code examples and API endpoint snippets.
---

The `<Aside>` component creates a sticky container that floats content to the right of your page. Use it to showcase code examples, API snippets, or any supplementary content that should stay visible as users scroll.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Callout'
description: 'Highlight important information, warnings, or tips in your documentation.'
title: Callout
description: Learn how to use the Callout component to add warnings, tips, notes, and alerts to your documentation with custom icons and intents.
---

The `<Callout>` component highlights important information, warnings, or tips in your documentation. Use callouts to emphasize critical details that readers shouldn't miss, such as breaking changes, prerequisites, or helpful best practices.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Frame'
description: 'Wrap images in a container with the frame component'
title: Frame
description: Use Fern's Frame component to display images with captions in your docs. Includes subtle background variants and properties.
---

The `<Frame>` component provides a container for images and other media with optional captions and backgrounds.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Components overview'
description: 'Built-in components for creating interactive documentation'
title: Components overview
description: Complete guide to Fern documentation components. Build better docs with accordions, callouts, tables, tabs, and interactive API features.
---

Fern includes 23 built-in components for creating interactive documentation. Select a component below to view usage examples and configuration options.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Fullstory
description: Learn how to integrate Fern Docs with Fullstory to track user behavior and analytics.
description: Integrate Fullstory with Fern docs to capture user sessions and interactions. Step-by-step instructions for adding your Org ID.
---

Integrate Fullstory to capture session replays and user interactions in your documentation.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/autorelease.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Fern Autorelease
description: Fern Autorelease automates SDK releases end-to-end, from detection to publishing
description: Automate SDK releases with Fern Autorelease. Detects API spec changes, regenerates SDKs, determines version bumps, and publishes to package registries.
---

Fern Autorelease automates SDK releases end-to-end. When your API specification changes, Autorelease regenerates SDKs, determines the version bump, and publishes to package registries.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/guides/configure-readme.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Customize README
description: Guide to configuring the README.md in SDKs
description: Customize your SDK README with Fern's generators.yml configuration. Add custom sections, control example styles, and organize endpoints by feature.
---

Each SDK includes a `README.md` file in its root directory that provides an overview of the SDK and instructions for working with the associated API.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/guides/customize-method-names.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Customize method names
description: Fine-tune SDK resources and method names
description: Learn how to customize SDK method names in Fern to create intuitive, user-friendly code. Configure group names and method structures for better API client design.
---

You can fine-tune your SDK method and group names to create intuitive, user-friendly
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/guides/generated-sdk.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: SDK user features
description: How your customers can use your SDK
description: Learn about SDK user features in Fern-generated client libraries including installation, error handling, webhook verification, and customization options.
---

Fern-generated SDKs provide a consistent set of features across all languages to help developers interact with your API. Usage information is auto-generated in your SDK's `README.md`, [which you can customize](./readme).
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/how-it-works.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: How SDKs work
description: Learn how Fern generates SDKs using cloud infrastructure
description: Understand Fern's SDK generation process. Cloud-based workflow transforms API specifications into production-ready client libraries automatically.
---

Fern combines your API specifications with generator configurations and custom code to produce SDKs in multiple languages. By default, SDK generation runs on Fern's managed cloud infrastructure.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: SDKs overview
description: Generate idiomatic SDKs in multiple programming languages
description: Build multi-language SDKs with Fern's generator platform. Support TypeScript, Python, Go, Java, .NET, PHP, Ruby, Swift, and Rust clients.
---

<div className="sdks-homepage">
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/overview/csharp/publishing-to-nuget.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Publishing to NuGet
description: How to publish the Fern .NET SDK to NuGet.
description: Learn how to publish your Fern-generated C#/.NET SDK to NuGet registry with step-by-step configuration, API key setup, and automated release workflows.
---

Publish your public-facing Fern C#/.NET SDK to the [NuGet
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Publishing as a Go module
description: How to publish the Fern Go SDK to the Go module proxy.
description: Learn how to publish your Fern-generated Go SDK to pkg.go.dev. Configure generators.yml and release versioned Go modules.
---

Publish your public-facing Fern Go SDK to
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/overview/java/configuration.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Java configuration
description: Configuration options for the Fern Java SDK.
description: Configure your Java SDK generator with custom client names, package prefixes, builder patterns, and Maven publishing options for Fern.
---
You can customize the behavior of the Java SDK generator in `generators.yml`:

Expand Down
4 changes: 2 additions & 2 deletions fern/products/sdks/overview/php/configuration.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: PHP configuration
description: Configuration options for the Fern PHP SDK.
description: Configure your PHP SDK generator with Fern. Customize client names, namespaces, package settings, and composer.json for PHP client libraries.
---

You can customize the behavior of the PHP SDK generator in `generators.yml`:
Expand All @@ -15,7 +15,7 @@ groups:
clientName: YourClientName
```

## SDK Configuration Options
## SDK configuration options

<ParamField path="clientName" type="string" required={false} toc={true}>
Sets the name of the generated API client class. This determines the primary client type name that users will interact with in the generated PHP SDK.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/overview/php/custom-code.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Adding custom code
description: Augment your PHP SDK with custom utilities
description: Learn how to add custom logic, methods, and dependencies to your PHP SDK. Step-by-step guide to extending Fern-generated PHP clients.
---

This page covers how to add custom logic, methods, and dependencies to your PHP SDK.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/overview/python/custom-code.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Adding custom code
description: Augment your Python SDK with custom utilities
description: Learn how to add custom logic, methods, and dependencies to your Python SDK. Extend Fern-generated clients with custom code.
---

This page covers how to add custom logic, methods, and dependencies to your Python SDK.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/overview/python/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Python quickstart
description: Get started quickly with the Fern Python SDK.
description: Learn how to generate a Python SDK with Fern. Step-by-step guide to configure generators.yml, run fern generate, and create client libraries.
---

Generate a Python SDK by following the instructions on this page.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/overview/ruby/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Ruby quickstart
description: Get started quickly with the Fern Ruby SDK.
description: Learn how to generate a Ruby SDK with Fern. Step-by-step guide to configure generators.yml, run fern generate, and create Ruby client libraries.
---

Generate a Ruby SDK by following the instructions on this page.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/overview/swift/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Swift quickstart
description: Get started quickly with the Fern Swift SDK.
description: Learn how to generate a Swift SDK with Fern. Step-by-step guide to configure generators.yml and create client libraries for your API.
---

Generate a Swift SDK by following the instructions on this page.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/overview/typescript/configuration.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: TypeScript configuration
description: Configuration options for the Fern TypeScript SDK.
description: Configure TypeScript SDK generation with Fern. Customize namespaces, enable serde layer, manage dependencies, and control file output.
---

You can customize the behavior of the TypeScript SDK generator in `generators.yml`:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Publishing to npm
description: How to publish the Fern TypeScript SDK to npm.
description: Learn how to publish your Fern TypeScript SDK to npm using OIDC or token-based authentication. Complete guide with GitHub Actions setup.
---

Publish your public-facing Fern TypeScript SDK to the [npmjs
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/overview/typescript/serde-layer.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: TypeScript serde layer
description: Control how your API naming conventions are transformed in the generated TypeScript SDK
description: Learn how to enable the TypeScript serde layer in Fern SDK generator to transform API field names to camelCase and validate requests at runtime.
---

Fern's TypeScript SDK generator includes an optional serde layer that determines whether the generated SDK matches your original API naming conventions (snake_case vs. camelCase, case-sensitive fields) or follows TypeScript conventions. This serde layer is controlled by the `noSerdeLayer` option.
Expand Down
Loading