diff --git a/fern/products/api-def/asyncapi/auth.mdx b/fern/products/api-def/asyncapi/auth.mdx index cbb7c595fe..1d22ad7123 100644 --- a/fern/products/api-def/asyncapi/auth.mdx +++ b/fern/products/api-def/asyncapi/auth.mdx @@ -142,8 +142,6 @@ 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/extensions/audiences.mdx b/fern/products/api-def/asyncapi/extensions/audiences.mdx index d2241bc7e7..0857e49a3f 100644 --- a/fern/products/api-def/asyncapi/extensions/audiences.mdx +++ b/fern/products/api-def/asyncapi/extensions/audiences.mdx @@ -5,7 +5,7 @@ subtitle: Use `x-fern-audiences` to filter to relevant operations, channels and --- - + 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/audiences.mdx b/fern/products/api-def/ferndef/audiences.mdx index 615652e6e0..323597402f 100644 --- a/fern/products/api-def/ferndef/audiences.mdx +++ b/fern/products/api-def/ferndef/audiences.mdx @@ -7,7 +7,7 @@ noindex: true - + 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. diff --git a/fern/products/api-def/ferndef/auth.mdx b/fern/products/api-def/ferndef/auth.mdx index add3f91105..656d23eb2e 100644 --- a/fern/products/api-def/ferndef/auth.mdx +++ b/fern/products/api-def/ferndef/auth.mdx @@ -182,8 +182,6 @@ 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/endpoints/sse.mdx b/fern/products/api-def/ferndef/endpoints/sse.mdx index c2c0777439..8775650a07 100644 --- a/fern/products/api-def/ferndef/endpoints/sse.mdx +++ b/fern/products/api-def/ferndef/endpoints/sse.mdx @@ -7,7 +7,7 @@ noindex: true - + Specifying `response-stream` on an endpoints allows you to represent endpoint responses that are streaming. diff --git a/fern/products/api-def/openapi/endpoints/sse.mdx b/fern/products/api-def/openapi/endpoints/sse.mdx index b393b5de36..1db334507c 100644 --- a/fern/products/api-def/openapi/endpoints/sse.mdx +++ b/fern/products/api-def/openapi/endpoints/sse.mdx @@ -42,7 +42,7 @@ components: ## Server-sent events - + If your API returns server-sent-events (SSE), with the `data` and `event` keys as seen below diff --git a/fern/products/api-def/openapi/extensions/audiences.mdx b/fern/products/api-def/openapi/extensions/audiences.mdx index e5f3432c3c..232ebeb23d 100644 --- a/fern/products/api-def/openapi/extensions/audiences.mdx +++ b/fern/products/api-def/openapi/extensions/audiences.mdx @@ -5,7 +5,7 @@ subtitle: Learn how to use x-fern-audiences to filter OpenAPI endpoints, schemas --- - + Fern provides two ways to filter which API elements appear in your SDKs and API Reference docs: diff --git a/fern/products/api-def/openapi/extensions/idempotency-headers.mdx b/fern/products/api-def/openapi/extensions/idempotency-headers.mdx index 444048f4b3..66aeef3b12 100644 --- a/fern/products/api-def/openapi/extensions/idempotency-headers.mdx +++ b/fern/products/api-def/openapi/extensions/idempotency-headers.mdx @@ -5,8 +5,6 @@ description: Configure idempotency for safe request retries using x-fern-idempot --- - - Fern supports idempotency configuration through two extensions that work together: `x-fern-idempotency-headers` configures the idempotency headers your API uses, and `x-fern-idempotent` marks individual endpoints as idempotent. When configured, Fern's generated SDKs allow users to specify idempotency headers for safe request retries. ## Configure idempotency headers diff --git a/fern/products/api-def/openapi/extensions/pagination.mdx b/fern/products/api-def/openapi/extensions/pagination.mdx index 4432925977..d49d26a0b6 100644 --- a/fern/products/api-def/openapi/extensions/pagination.mdx +++ b/fern/products/api-def/openapi/extensions/pagination.mdx @@ -5,8 +5,6 @@ description: Configure auto-pagination for list endpoints using the x-fern-pagin --- - - The `x-fern-pagination` extension configures auto-pagination for list endpoints in your OpenAPI specification. [SDK](/learn/sdks/deep-dives/auto-pagination) and [CLI](/learn/cli-generator/get-started/openapi-extensions#pagination) users get automatic pagination without managing page tokens manually. To configure pagination: diff --git a/fern/products/dashboard/pages/pdf-export.mdx b/fern/products/dashboard/pages/pdf-export.mdx index 8ca982a3cf..56cb8f9095 100644 --- a/fern/products/dashboard/pages/pdf-export.mdx +++ b/fern/products/dashboard/pages/pdf-export.mdx @@ -4,8 +4,6 @@ description: Export your documentation site as a PDF from the Fern Dashboard. --- - - Export your documentation as a PDF directly from the [Fern Dashboard](https://dashboard.buildwithfern.com/). The generated PDF includes a cover page, table of contents with clickable links, and all content pages with headers and footers. ## Export your documentation diff --git a/fern/products/dashboard/pages/permissions.mdx b/fern/products/dashboard/pages/permissions.mdx index 4e28fa2073..fc215f1ff7 100644 --- a/fern/products/dashboard/pages/permissions.mdx +++ b/fern/products/dashboard/pages/permissions.mdx @@ -90,6 +90,5 @@ Your [plan](https://buildwithfern.com/pricing) determines how many members you c | Plan | Team members | | ---------- | ------------ | -| Hobby | 2 | -| Team | 5 | +| Free | 10 | | Enterprise | Custom | diff --git a/fern/products/docs/pages/ai/overview.mdx b/fern/products/docs/pages/ai/overview.mdx index 51be0a3225..2ce98646a3 100644 --- a/fern/products/docs/pages/ai/overview.mdx +++ b/fern/products/docs/pages/ai/overview.mdx @@ -8,7 +8,7 @@ Your documentation site comes with automatic optimizations for AI tools, plus fe - AI features are usage-based and consume credits. Every [plan](https://buildwithfern.com/pricing) includes a monthly credit allowance: Hobby plans get 250 credits, Team plans get 1,000 credits, and Enterprise plans get a custom amount. + AI features are usage-based and consume credits. Every [plan](https://buildwithfern.com/pricing) includes a monthly credit allowance: the Free plan gets 250 credits, and the Enterprise plan gets a custom amount. | Feature | Credits | | --- | --- | diff --git a/fern/products/docs/pages/api-references/audiences.mdx b/fern/products/docs/pages/api-references/audiences.mdx index 42e1b123c5..8953d9a05f 100644 --- a/fern/products/docs/pages/api-references/audiences.mdx +++ b/fern/products/docs/pages/api-references/audiences.mdx @@ -4,8 +4,6 @@ subtitle: Use audiences to filter the endpoints, schemas, and properties that ar --- - - 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/docs/pages/ask-fern/api-get-started.mdx b/fern/products/docs/pages/ask-fern/api-get-started.mdx index b065279524..cfecf6fd5b 100644 --- a/fern/products/docs/pages/ask-fern/api-get-started.mdx +++ b/fern/products/docs/pages/ask-fern/api-get-started.mdx @@ -4,8 +4,6 @@ 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: - Build your own support integrations that leverage Ask Fern's AI-powered search diff --git a/fern/products/docs/pages/authentication/rbac.mdx b/fern/products/docs/pages/authentication/rbac.mdx index a2e04ab2f9..ecbdac1c76 100644 --- a/fern/products/docs/pages/authentication/rbac.mdx +++ b/fern/products/docs/pages/authentication/rbac.mdx @@ -4,9 +4,7 @@ subtitle: Show different docs to different customers description: Restrict pages by role, team, or pricing tier so each audience sees only what they should. --- - - Password-based RBAC is available on the [Team and Enterprise plans](https://buildwithfern.com/pricing). SSO, JWT, and OAuth-based RBAC require the [Enterprise plan](https://buildwithfern.com/pricing). - + RBAC gates pages, sections, and other navigation items by role so each audience sees only the content meant for them. It works with [password protection](/learn/docs/authentication/setup/password-protection), [SSO](/learn/docs/authentication/setup/sso), [JWT](/learn/docs/authentication/setup/jwt), and [OAuth](/learn/docs/authentication/setup/oauth) authentication. diff --git a/fern/products/docs/pages/customization/custom-css-js.mdx b/fern/products/docs/pages/customization/custom-css-js.mdx index 12b69150f2..01e31a5545 100644 --- a/fern/products/docs/pages/customization/custom-css-js.mdx +++ b/fern/products/docs/pages/customization/custom-css-js.mdx @@ -4,6 +4,7 @@ subtitle: Add custom CSS, global JavaScript, and UI components. description: Learn how to add custom CSS, JavaScript, and UI components to your Fern documentation. Style your docs with custom classes and scripts. --- + This page covers CSS and JavaScript customization: diff --git a/fern/products/docs/pages/customization/custom-react-components.mdx b/fern/products/docs/pages/customization/custom-react-components.mdx index 8044f798a1..703e90785b 100644 --- a/fern/products/docs/pages/customization/custom-react-components.mdx +++ b/fern/products/docs/pages/customization/custom-react-components.mdx @@ -4,6 +4,8 @@ description: Add custom React components to your Fern docs for interactive, serv slug: customization/custom-react-components --- + + You can extend Fern's built-in component library by adding your own custom React components. This allows you to create unique, interactive elements that match your documentation needs. Components are server-side rendered for better SEO and performance, with no layout shifts. diff --git a/fern/products/docs/pages/integrations/feature-flags.mdx b/fern/products/docs/pages/integrations/feature-flags.mdx index eb5ceb2696..b5dae535e4 100644 --- a/fern/products/docs/pages/integrations/feature-flags.mdx +++ b/fern/products/docs/pages/integrations/feature-flags.mdx @@ -5,8 +5,6 @@ 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/localization/overview.mdx b/fern/products/docs/pages/localization/overview.mdx index 7c347d83e5..1d8d564359 100644 --- a/fern/products/docs/pages/localization/overview.mdx +++ b/fern/products/docs/pages/localization/overview.mdx @@ -3,6 +3,8 @@ title: Localization subtitle: Ship documentation in multiple languages from a single source --- + + Fern lets you publish your documentation in multiple languages from a single set of source files. Readers switch languages from a dropdown in the header, [search](/learn/docs/customization/search) is scoped to the active language, and each locale has its own URL so search engines can index it separately. You supply the translations and Fern handles the rest: rendering a language switcher in the header, scoping each locale to its own URL path, and falling back to the default language for any page you haven't translated yet. diff --git a/fern/products/docs/pages/navigation/products.mdx b/fern/products/docs/pages/navigation/products.mdx index af5aa5ebaa..73c60e9793 100644 --- a/fern/products/docs/pages/navigation/products.mdx +++ b/fern/products/docs/pages/navigation/products.mdx @@ -5,8 +5,6 @@ description: Configure multi-product documentation in Fern, including the produc --- - - Products add a switcher to your docs for documenting distinct offerings. Each product can contain its own navigation, tabs, versions, and API references, and products can share content. Products can be internal (hosted on your site) or external (linking to external URLs). diff --git a/fern/products/docs/pages/navigation/versions.mdx b/fern/products/docs/pages/navigation/versions.mdx index 4dce2624d5..f31b1ebf91 100644 --- a/fern/products/docs/pages/navigation/versions.mdx +++ b/fern/products/docs/pages/navigation/versions.mdx @@ -5,8 +5,6 @@ description: Configure versioned documentation in Fern, including the version dr --- - - Versions add a dropdown to your docs for multiple releases of the same content. Each version can contain its own tabs, sections, pages, and API references, and versions can share content. diff --git a/fern/products/docs/pages/preview-publish/setting-up-your-domain.mdx b/fern/products/docs/pages/preview-publish/setting-up-your-domain.mdx index 34f5b5bafa..4219de73b7 100644 --- a/fern/products/docs/pages/preview-publish/setting-up-your-domain.mdx +++ b/fern/products/docs/pages/preview-publish/setting-up-your-domain.mdx @@ -76,8 +76,6 @@ Once Fern has completed your setup, you'll be able to access your documentation - - To host your documentation on a subpath like `mydomain.com/docs`, you need to edit your `docs.yml` configuration and set up a reverse proxy on your infrastructure. diff --git a/fern/products/sdks/deep-dives/configure-auto-pagination.mdx b/fern/products/sdks/deep-dives/configure-auto-pagination.mdx index 7fe1f56c5c..a3b1c1e061 100644 --- a/fern/products/sdks/deep-dives/configure-auto-pagination.mdx +++ b/fern/products/sdks/deep-dives/configure-auto-pagination.mdx @@ -4,8 +4,6 @@ description: Paginate through API responses with offset, cursor, URI, and path-b --- - - Fern's auto-pagination supports offset, cursor, URI, and path-based pagination schemes, providing SDK users with simple iterators to loop through all results instead of managing pagination complexity manually. diff --git a/fern/products/sdks/deep-dives/configure-idempotency.mdx b/fern/products/sdks/deep-dives/configure-idempotency.mdx index 76476097b5..f62cf57687 100644 --- a/fern/products/sdks/deep-dives/configure-idempotency.mdx +++ b/fern/products/sdks/deep-dives/configure-idempotency.mdx @@ -4,8 +4,6 @@ description: Configure idempotency headers for SDKs that support retrying reques --- - - For endpoints you've configured as idempotent, Fern's SDKs allow users to specify idempotency headers for safe request retries. Typically the headers include `Idempotency-Key`, but you can also specify additional headers. diff --git a/fern/products/sdks/deep-dives/retries-with-backoff.mdx b/fern/products/sdks/deep-dives/retries-with-backoff.mdx index 8157118760..1dab1fdec4 100644 --- a/fern/products/sdks/deep-dives/retries-with-backoff.mdx +++ b/fern/products/sdks/deep-dives/retries-with-backoff.mdx @@ -4,8 +4,6 @@ description: Learn how to configure automatic retries with exponential backoff i --- - - Fern SDKs will automatically retry failed requests with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit. diff --git a/fern/snippets/enterprise-plan-sdks.mdx b/fern/snippets/enterprise-plan-sdks.mdx new file mode 100644 index 0000000000..2ae4146927 --- /dev/null +++ b/fern/snippets/enterprise-plan-sdks.mdx @@ -0,0 +1,3 @@ + + Using this feature in generated SDKs requires the [Enterprise plan](https://buildwithfern.com/pricing). API Reference docs can use it on all plans. To get started, reach out to support@buildwithfern.com. +