diff --git a/fern/products/api-def/asyncapi-pages/auth.mdx b/fern/products/api-def/asyncapi-pages/auth.mdx index 57f8bde2b..8083f6001 100644 --- a/fern/products/api-def/asyncapi-pages/auth.mdx +++ b/fern/products/api-def/asyncapi-pages/auth.mdx @@ -141,6 +141,8 @@ components: ## OAuth2 security scheme + + OAuth2 authentication is supported for AsyncAPI specifications: ```yml title="asyncapi.yml" {3-11} diff --git a/fern/products/api-def/asyncapi-pages/extensions/audiences.mdx b/fern/products/api-def/asyncapi-pages/extensions/audiences.mdx index bc1118a80..d5d581442 100644 --- a/fern/products/api-def/asyncapi-pages/extensions/audiences.mdx +++ b/fern/products/api-def/asyncapi-pages/extensions/audiences.mdx @@ -3,6 +3,8 @@ title: Use audiences to filter your API subtitle: Use `x-fern-audiences` to filter to relevant operations, channels and message schemas --- + + Audiences are a useful tool for segmenting your event-driven API for different consumers. Common examples of audiences include `public` and `beta`. diff --git a/fern/products/api-def/ferndef-pages/audiences.mdx b/fern/products/api-def/ferndef-pages/audiences.mdx index e916711f7..06846941c 100644 --- a/fern/products/api-def/ferndef-pages/audiences.mdx +++ b/fern/products/api-def/ferndef-pages/audiences.mdx @@ -3,6 +3,8 @@ title: Audiences in Fern Definition subtitle: Use audiences in your Fern Definition to segment your API for different groups of consumers. --- + + Audiences are a useful tool for segmenting your API for different consumers. You can configure your Fern Docs to publish documentation specific to an `Audience`. You can use [audiences in your OpenAPI Specification](/learn/api-definitions/openapi/extensions/audiences), too. Common examples of audiences include: diff --git a/fern/products/api-def/ferndef-pages/auth.mdx b/fern/products/api-def/ferndef-pages/auth.mdx index a4fac813f..e3ec38870 100644 --- a/fern/products/api-def/ferndef-pages/auth.mdx +++ b/fern/products/api-def/ferndef-pages/auth.mdx @@ -178,6 +178,8 @@ client = new Client({ ## OAuth client credentials + + If your API uses OAuth, you can specify an oauth scheme in `api.yml` and define a token retrieval endpoint in a separate `auth.yml` file ([example](https://github.com/fern-api/fern/blob/3137938b70e058f3691ddef34d5c1cc29acc4b80/test-definitions/fern/apis/oauth-client-credentials/definition/api.yml)). ```yaml api.yml diff --git a/fern/products/api-def/ferndef-pages/endpoints/sse.mdx b/fern/products/api-def/ferndef-pages/endpoints/sse.mdx index c1ab53770..a61c4b177 100644 --- a/fern/products/api-def/ferndef-pages/endpoints/sse.mdx +++ b/fern/products/api-def/ferndef-pages/endpoints/sse.mdx @@ -3,10 +3,9 @@ title: Server-Sent Events and Streaming APIs subtitle: Use the `response-stream` key to model streaming endpoints --- - - Specifying `response-stream` on an endpoints allows you to represent endpoint responses that are streaming. - + +Specifying `response-stream` on an endpoints allows you to represent endpoint responses that are streaming. ## JSON streaming diff --git a/fern/products/api-def/ferndef-pages/websockets.mdx b/fern/products/api-def/ferndef-pages/websockets.mdx index efac1a6e0..ec637659b 100644 --- a/fern/products/api-def/ferndef-pages/websockets.mdx +++ b/fern/products/api-def/ferndef-pages/websockets.mdx @@ -87,7 +87,7 @@ Fern renders a unique reference page for WebSockets. The **Handshake** section o ### WebSocket Playground - + Users can connect to and use WebSockets from right within the API Reference (check one of Hume's WebSockets [here](https://dev.hume.ai/reference/empathic-voice-interface-evi/chat/chat)). diff --git a/fern/products/api-def/grpc-pages/overview.mdx b/fern/products/api-def/grpc-pages/overview.mdx index 236c257ba..b9a52d6c7 100644 --- a/fern/products/api-def/grpc-pages/overview.mdx +++ b/fern/products/api-def/grpc-pages/overview.mdx @@ -3,6 +3,8 @@ title: What is gRPC? description: gRPC is a high-performance RPC framework that uses Protocol Buffers --- + + Fern only supports gRPC SDK generation for .NET/C#. diff --git a/fern/products/api-def/openapi-pages/endpoints/sse.mdx b/fern/products/api-def/openapi-pages/endpoints/sse.mdx index bc680cfe1..05b898fac 100644 --- a/fern/products/api-def/openapi-pages/endpoints/sse.mdx +++ b/fern/products/api-def/openapi-pages/endpoints/sse.mdx @@ -3,10 +3,7 @@ title: Server-Sent Events and Streaming APIs subtitle: Use the `x-fern-streaming` extension to model streaming endpoints --- - - The `x-fern-streaming` extension allows you to represent endpoints that are streaming. - - +The `x-fern-streaming` extension allows you to represent endpoints that are streaming. ## JSON streaming @@ -42,6 +39,8 @@ components: ## Server-sent events + + If your API returns server-sent-events, with the `data` and `event` keys as seen below ```json diff --git a/fern/products/api-def/openapi-pages/extensions/audiences.mdx b/fern/products/api-def/openapi-pages/extensions/audiences.mdx index 8bd80fc5f..4690e64f3 100644 --- a/fern/products/api-def/openapi-pages/extensions/audiences.mdx +++ b/fern/products/api-def/openapi-pages/extensions/audiences.mdx @@ -3,6 +3,8 @@ title: Use audiences to filter your API subtitle: Use `x-fern-audiences` to filter to relevant endpoints, schemas and properties --- + + Audiences are a useful tool for segmenting your API for different consumers. Common examples of audiences include `public` and `beta`. diff --git a/fern/products/api-def/openrpc-pages/overview.mdx b/fern/products/api-def/openrpc-pages/overview.mdx index d08122d45..4d13ee3d0 100644 --- a/fern/products/api-def/openrpc-pages/overview.mdx +++ b/fern/products/api-def/openrpc-pages/overview.mdx @@ -3,6 +3,8 @@ title: What is an OpenRPC Specification? description: OpenRPC is a standard for documenting JSON-RPC APIs --- + + The OpenRPC Specification is a framework used by developers to document JSON-RPC APIs. The specification is written in JSON or YAML and contains all of your methods, parameters, schemas, and server configurations. Fern is compatible with OpenRPC specification [v1.3.2](https://spec.open-rpc.org/) and [v1.2.6](https://github.com/open-rpc/spec/releases/tag/1.2.6). diff --git a/fern/products/api-def/pages/project-structure.mdx b/fern/products/api-def/pages/project-structure.mdx index ca8a74ef5..f6a952794 100644 --- a/fern/products/api-def/pages/project-structure.mdx +++ b/fern/products/api-def/pages/project-structure.mdx @@ -106,6 +106,10 @@ groups: + + This feature is available only for the [Pro and Enterprise plans](https://buildwithfern.com/pricing). You can merge up to five APIs into a single SDK on the Pro plan, and unlimited APIs on the Enterprise plan. To get started, reach out to support@buildwithfern.com. + + Use this approach to merge multiple APIs into a single set of SDKs. ```bash diff --git a/fern/products/ask-fern/pages/getting-started/api-get-started.mdx b/fern/products/ask-fern/pages/getting-started/api-get-started.mdx index ed17e1f59..ea3d4616a 100644 --- a/fern/products/ask-fern/pages/getting-started/api-get-started.mdx +++ b/fern/products/ask-fern/pages/getting-started/api-get-started.mdx @@ -3,7 +3,7 @@ title: 'Introduction' subtitle: 'Welcome to the Fern API reference.' --- - + The Fern AI API allows you to manage your Ask Fern configuration using Fern's public RESTful API. You can use the API to: diff --git a/fern/products/cli-api-reference/pages/api-get-started.mdx b/fern/products/cli-api-reference/pages/api-get-started.mdx index 83c436ddd..b9ffdced0 100644 --- a/fern/products/cli-api-reference/pages/api-get-started.mdx +++ b/fern/products/cli-api-reference/pages/api-get-started.mdx @@ -3,7 +3,7 @@ title: 'Introduction' subtitle: 'Welcome to the Fern API reference.' --- - + The Fern API allows you to manage SDKs and code snippets using Fern's public RESTful API. diff --git a/fern/products/docs/pages/api-references/audiences.mdx b/fern/products/docs/pages/api-references/audiences.mdx index 19bc17326..205272b1a 100644 --- a/fern/products/docs/pages/api-references/audiences.mdx +++ b/fern/products/docs/pages/api-references/audiences.mdx @@ -3,6 +3,8 @@ title: Audiences subtitle: Use audiences to filter the endpoints, schemas, and properties that are displayed in your API Reference. --- + + Audiences are a useful tool for segmenting your API for different consumers. Common examples of audiences include `public` and `beta`. You can configure audiences in both [the OpenAPI Specification](/learn/api-definitions/openapi/extensions/audiences) as well as [the Fern Definition](/learn/api-definition/fern/audiences). 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 a0bec714d..59b66624d 100644 --- a/fern/products/docs/pages/api-references/autopopulate-api-key.mdx +++ b/fern/products/docs/pages/api-references/autopopulate-api-key.mdx @@ -3,9 +3,7 @@ title: Auto-populate API keys subtitle: Make integrating with your API frictionless by adding your login flow to the API Explorer. --- - -This feature is available on the Pro plan. [Contact us](https://buildwithfern.com/contact) to learn more. - + Fern can integrate with your authentication flow, allowing users to login and have their API key automatically populated with the click of a button. diff --git a/fern/products/docs/pages/api-references/generate-websocket-ref.mdx b/fern/products/docs/pages/api-references/generate-websocket-ref.mdx index 5d446e66b..5b8d31e5b 100644 --- a/fern/products/docs/pages/api-references/generate-websocket-ref.mdx +++ b/fern/products/docs/pages/api-references/generate-websocket-ref.mdx @@ -3,6 +3,8 @@ title: Generate WebSocket Reference description: Learn how to generate and customize WebSocket API reference documentation --- + + Fern generates WebSocket API reference documentation from your AsyncAPI specification or Fern Definition. The AsyncAPI specification describes message-driven APIs in a machine-readable format. Fern supports the [v2](https://www.asyncapi.com/docs/reference/specification/v2.x) and [v3](https://www.asyncapi.com/docs/reference/specification/v3.0.0) specifications. Example of how a WebSocket API Reference renders in Fern}> diff --git a/fern/products/docs/pages/api-references/sdk-snippets.mdx b/fern/products/docs/pages/api-references/sdk-snippets.mdx index 3e711c02a..ffb008000 100644 --- a/fern/products/docs/pages/api-references/sdk-snippets.mdx +++ b/fern/products/docs/pages/api-references/sdk-snippets.mdx @@ -132,7 +132,9 @@ navigation: ## Access via API -If you'd like to bring SDK snippets into your own documentation, you can use the [Snippets API](/learn/api-reference/snippets/get). API access requires a [SDK Business plan](https://buildwithfern.com/pricing) or above. + + +If you'd like to bring SDK snippets into your own documentation, you can use the [Snippets API](/learn/api-reference/snippets/get). Merge.dev is an example of a Fern customer that uses the Snippets API to bring Python code samples [into their API Reference](https://docs.merge.dev/hris/employees/#employees_list). diff --git a/fern/products/docs/pages/authentication/rbac.mdx b/fern/products/docs/pages/authentication/rbac.mdx index 6f5ed5874..668be4017 100644 --- a/fern/products/docs/pages/authentication/rbac.mdx +++ b/fern/products/docs/pages/authentication/rbac.mdx @@ -4,7 +4,7 @@ subtitle: Control who can view your documentation description: Learn how to restrict access to your documentation using role-based access control (RBAC) --- -RBAC is part of the pro plan. + ## Introduction diff --git a/fern/products/docs/pages/authentication/sso.mdx b/fern/products/docs/pages/authentication/sso.mdx index 6c362121c..897796043 100644 --- a/fern/products/docs/pages/authentication/sso.mdx +++ b/fern/products/docs/pages/authentication/sso.mdx @@ -3,6 +3,8 @@ title: Single Sign-On subtitle: Enterprise authentication for secure access to your docs --- + + Fern’s Single Sign-On (SSO) is an enterprise feature that lets your team securely access your docs through your organization’s identity provider. SSO does not support Role-Based Access Control or API Key Injection. @@ -47,5 +49,5 @@ Fern supports SSO integration with any identity provider that implements industr ## Setting up SSO -SSO is available as part of the Enterprise plan. Reach out via Slack or [contact our team](https://buildwithfern.com/contact) to begin the SSO setup process. Fern will work with one of your security administrators to connect to your identity provider. +Reach out via Slack or [contact our team](https://buildwithfern.com/contact) to begin the SSO setup process. Fern will work with one of your security administrators to connect to your identity provider. diff --git a/fern/products/docs/pages/component-library/custom-components/custom-css-js.mdx b/fern/products/docs/pages/component-library/custom-components/custom-css-js.mdx index ae65bfe7b..222537351 100644 --- a/fern/products/docs/pages/component-library/custom-components/custom-css-js.mdx +++ b/fern/products/docs/pages/component-library/custom-components/custom-css-js.mdx @@ -4,11 +4,6 @@ subtitle: Add custom CSS, global JavaScript, and UI components. description: Add brand-specific styling, user interactions. and components to make your docs your own. --- - -Custom CSS & JS are available on the Basic plan. -Adding Custom Components is available on the Pro plan. - - This page covers how to customize your docs with CSS, JavaScript, and custom components. However, you can [customize many things directly in your `docs.yml` file](/docs/configuration/what-is-docs-yml), including colors, typography, navbar links, layout, analytics, and metadata. Try these built-in options first before adding custom code. ## Custom CSS @@ -204,6 +199,8 @@ js: ## Custom components + + You can use custom CSS and JS to replace Fern's default UI components with your own. The `header` and `footer` are the most commonly replaced components. You can replace any component in the docs, including the sidebar, tabs, search bar, and more. diff --git a/fern/products/docs/pages/enterprise/self-hosted-set-up.mdx b/fern/products/docs/pages/enterprise/self-hosted-set-up.mdx index b2552368b..bb0eafa11 100644 --- a/fern/products/docs/pages/enterprise/self-hosted-set-up.mdx +++ b/fern/products/docs/pages/enterprise/self-hosted-set-up.mdx @@ -3,7 +3,7 @@ title: Set up self-hosted documentation description: Learn how to set up self-hosted documentation on your own infrastructure. --- -Self-hosted documentation is only available for the enterprise plan. + ## Prerequisites diff --git a/fern/products/docs/pages/enterprise/self-hosted.mdx b/fern/products/docs/pages/enterprise/self-hosted.mdx index b7672c42f..d38d9a1a0 100644 --- a/fern/products/docs/pages/enterprise/self-hosted.mdx +++ b/fern/products/docs/pages/enterprise/self-hosted.mdx @@ -3,7 +3,7 @@ title: Self-hosted documentation description: Fern supports self-hosting so that you can run your docs site on your own infrastructure. --- -Self-hosted documentation is only available for the enterprise plan. + Fern documentation websites are hosted on Fern's infrastructure by default. Self-hosting allows you to deploy your documentation site on your own infrastructure to meet specific security or compliance requirements. diff --git a/fern/products/docs/pages/integrations/feature-flags.mdx b/fern/products/docs/pages/integrations/feature-flags.mdx index 76d358cf6..5559e7855 100644 --- a/fern/products/docs/pages/integrations/feature-flags.mdx +++ b/fern/products/docs/pages/integrations/feature-flags.mdx @@ -4,6 +4,8 @@ subtitle: Control documentation visibility with LaunchDarkly description: Learn how to use Feature Flags in your Fern documentation --- + + Fern supports conditional rendering of documentation content using feature flags, powered by [LaunchDarkly](https://app.launchdarkly.com/signup) integration. Control visibility of documentation sections based on feature flag states for different release stages or user segments. ## Use Cases diff --git a/fern/products/docs/pages/integrations/overview.mdx b/fern/products/docs/pages/integrations/overview.mdx index 78652f1e8..b49af82bd 100644 --- a/fern/products/docs/pages/integrations/overview.mdx +++ b/fern/products/docs/pages/integrations/overview.mdx @@ -97,4 +97,6 @@ are available during the workflow run. ## Connect other integrations + + If you want to integrate with a third-party analytics or support platforms that Fern doesn't directly support, you can do so [using custom JS](/docs/customization/custom-css-js#custom-javascript). diff --git a/fern/products/docs/pages/integrations/postman.mdx b/fern/products/docs/pages/integrations/postman.mdx index efe30e898..7089d7d7d 100644 --- a/fern/products/docs/pages/integrations/postman.mdx +++ b/fern/products/docs/pages/integrations/postman.mdx @@ -3,6 +3,8 @@ title: "Postman Integration" description: "Generate a postman collection full of example requests and responses" --- + + You can generate a Postman collection full of example requests and responses and publish your collection to Postman. The configuration for the postman generator lives in your fern folder, in a file called diff --git a/fern/products/docs/pages/navigation/products.mdx b/fern/products/docs/pages/navigation/products.mdx index 880170cb7..8960ca8d5 100644 --- a/fern/products/docs/pages/navigation/products.mdx +++ b/fern/products/docs/pages/navigation/products.mdx @@ -3,6 +3,8 @@ title: Product switching subtitle: Allow users to seamlessly navigate between different products you offer. --- + +