diff --git a/fern/products/api-def/openapi-pages/extensions/ignore.mdx b/fern/products/api-def/openapi-pages/extensions/ignore.mdx index 3a2e724b0..03be669a1 100644 --- a/fern/products/api-def/openapi-pages/extensions/ignore.mdx +++ b/fern/products/api-def/openapi-pages/extensions/ignore.mdx @@ -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. diff --git a/fern/products/api-def/openapi-pages/webhooks.mdx b/fern/products/api-def/openapi-pages/webhooks.mdx index b1ad3d229..f3637d050 100644 --- a/fern/products/api-def/openapi-pages/webhooks.mdx +++ b/fern/products/api-def/openapi-pages/webhooks.mdx @@ -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: diff --git a/fern/products/api-def/openrpc-pages/extensions/sdk-group-name.mdx b/fern/products/api-def/openrpc-pages/extensions/sdk-group-name.mdx index 9e2107014..a02380add 100644 --- a/fern/products/api-def/openrpc-pages/extensions/sdk-group-name.mdx +++ b/fern/products/api-def/openrpc-pages/extensions/sdk-group-name.mdx @@ -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: diff --git a/fern/products/api-def/openrpc-pages/overview.mdx b/fern/products/api-def/openrpc-pages/overview.mdx index b957910f7..27d918722 100644 --- a/fern/products/api-def/openrpc-pages/overview.mdx +++ b/fern/products/api-def/openrpc-pages/overview.mdx @@ -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. --- diff --git a/fern/products/ask-fern/pages/features/analytics.mdx b/fern/products/ask-fern/pages/features/analytics.mdx index ed425a7a7..c5cbc8a4e 100644 --- a/fern/products/ask-fern/pages/features/analytics.mdx +++ b/fern/products/ask-fern/pages/features/analytics.mdx @@ -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. diff --git a/fern/products/ask-fern/pages/features/guidance.mdx b/fern/products/ask-fern/pages/features/guidance.mdx index 94352ae0e..8857b4dc9 100644 --- a/fern/products/ask-fern/pages/features/guidance.mdx +++ b/fern/products/ask-fern/pages/features/guidance.mdx @@ -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. diff --git a/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx b/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx index 563c0c7ec..01596ac5d 100644 --- a/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx +++ b/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx @@ -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. diff --git a/fern/products/docs/pages/ai/ai-examples.mdx b/fern/products/docs/pages/ai/ai-examples.mdx index 49a560b2c..0e0144cd7 100644 --- a/fern/products/docs/pages/ai/ai-examples.mdx +++ b/fern/products/docs/pages/ai/ai-examples.mdx @@ -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. diff --git a/fern/products/docs/pages/ai/llms-txt.mdx b/fern/products/docs/pages/ai/llms-txt.mdx index c4123501f..936de2018 100644 --- a/fern/products/docs/pages/ai/llms-txt.mdx +++ b/fern/products/docs/pages/ai/llms-txt.mdx @@ -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. diff --git a/fern/products/docs/pages/ai/overview.mdx b/fern/products/docs/pages/ai/overview.mdx index 53c418469..fdf53f4c7 100644 --- a/fern/products/docs/pages/ai/overview.mdx +++ b/fern/products/docs/pages/ai/overview.mdx @@ -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. diff --git a/fern/products/docs/pages/api-references/api-ref-content.mdx b/fern/products/docs/pages/api-references/api-ref-content.mdx index a2398d46f..14226ca3b 100644 --- a/fern/products/docs/pages/api-references/api-ref-content.mdx +++ b/fern/products/docs/pages/api-references/api-ref-content.mdx @@ -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. diff --git a/fern/products/docs/pages/api-references/autopopulate-api-key.mdx b/fern/products/docs/pages/api-references/autopopulate-api-key.mdx index 13aa56181..314238558 100644 --- a/fern/products/docs/pages/api-references/autopopulate-api-key.mdx +++ b/fern/products/docs/pages/api-references/autopopulate-api-key.mdx @@ -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. --- diff --git a/fern/products/docs/pages/authentication/sso.mdx b/fern/products/docs/pages/authentication/sso.mdx index bf1999039..a0c5884a7 100644 --- a/fern/products/docs/pages/authentication/sso.mdx +++ b/fern/products/docs/pages/authentication/sso.mdx @@ -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. --- diff --git a/fern/products/docs/pages/component-library/custom-components/custom-react-components.mdx b/fern/products/docs/pages/component-library/custom-components/custom-react-components.mdx index 2bc5dabb8..e86f18193 100644 --- a/fern/products/docs/pages/component-library/custom-components/custom-react-components.mdx +++ b/fern/products/docs/pages/component-library/custom-components/custom-react-components.mdx @@ -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. --- @@ -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). -## How does it work? +## How it works ### Create a React component diff --git a/fern/products/docs/pages/component-library/default-components/aside.mdx b/fern/products/docs/pages/component-library/default-components/aside.mdx index 581ecab25..e8a753c14 100644 --- a/fern/products/docs/pages/component-library/default-components/aside.mdx +++ b/fern/products/docs/pages/component-library/default-components/aside.mdx @@ -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 `