diff --git a/fern/products/docs/pages/ai/ai-examples.mdx b/fern/products/docs/pages/ai/ai-examples.mdx index 7b2b737d0..a1f878f98 100644 --- a/fern/products/docs/pages/ai/ai-examples.mdx +++ b/fern/products/docs/pages/ai/ai-examples.mdx @@ -37,13 +37,6 @@ ai-examples: style: "Use names and emails that are inspired by plants." ``` -Or disable the feature entirely: - -```yaml docs.yml -ai-examples: - enabled: false -``` - AI-generated examples are written to `ai_examples_override.yml`. Edit this file to customize specific examples. To regenerate examples on each build instead, add the file to `.gitignore`: ```txt .gitignore @@ -53,3 +46,12 @@ AI-generated examples are written to `ai_examples_override.yml`. Edit this file To make AI-generated examples portable to non-Fern OpenAPI tools, use [`fern api enrich`](/learn/cli-api-reference/cli-reference/commands#fern-api-enrich) to merge them into native OpenAPI example fields. + +## Disable AI-generated examples + +To turn the feature off entirely, set `enabled` to `false`: + +```yaml docs.yml +ai-examples: + enabled: false +``` diff --git a/fern/products/docs/pages/ai/mcp-server.mdx b/fern/products/docs/pages/ai/mcp-server.mdx index 0892ec6d8..2e6373129 100644 --- a/fern/products/docs/pages/ai/mcp-server.mdx +++ b/fern/products/docs/pages/ai/mcp-server.mdx @@ -86,7 +86,7 @@ For Cursor, VS Code, and other clients, add `FERN_TOKEN: ` to the `headers` JWTs expire. Re-run the token exchange when the token lapses. There is no automatic refresh mechanism in the MCP transport. -## Disable the server +## Disable the MCP server To turn the server off entirely, set `mcp` to `false` in your [`page-actions` configuration](/learn/docs/configuration/site-level-settings#page-actionsoptions.mcp): diff --git a/fern/products/docs/pages/api-references/api-explorer.mdx b/fern/products/docs/pages/api-references/api-explorer.mdx index acf6975fb..c47c45f07 100644 --- a/fern/products/docs/pages/api-references/api-explorer.mdx +++ b/fern/products/docs/pages/api-references/api-explorer.mdx @@ -53,6 +53,8 @@ For APIs that support WebSocket connections, the API Explorer includes a **WebSo
-## Control API Explorer availability +## Disable the API Explorer -For OpenAPI specs, the API Explorer is enabled by default for all endpoints. You can disable it globally or per endpoint using the [`x-fern-explorer`](/learn/api-definitions/openapi/extensions/api-explorer-control) extension. This is commonly used to disable the Explorer for destructive operations, payment processing, or admin-only endpoints. +For OpenAPI specs, the API Explorer is enabled by default for all endpoints. To turn it off globally or per endpoint, use the [`x-fern-explorer`](/learn/api-definitions/openapi/extensions/api-explorer-control) extension. This is commonly used to disable the Explorer for destructive operations, payment processing, or admin-only endpoints. + +Setting [`disable-explorer-proxy`](/learn/docs/configuration/site-level-settings#settingsdisable-explorer-proxy) does not turn the Explorer off. It keeps the Explorer running and routes requests directly to your API instead of through Fern's proxy. diff --git a/fern/products/docs/pages/ask-fern/what-is-ask-fern.mdx b/fern/products/docs/pages/ask-fern/what-is-ask-fern.mdx index a856ff495..6b4c2aa33 100644 --- a/fern/products/docs/pages/ask-fern/what-is-ask-fern.mdx +++ b/fern/products/docs/pages/ask-fern/what-is-ask-fern.mdx @@ -21,7 +21,7 @@ Ask Fern is Fern's AI Search feature, powered by [Claude 4.6 Sonnet](https://www - Open the [Fern Dashboard](https://dashboard.buildwithfern.com/). Navigate to the **Settings** tab and click **Enable** on the Ask AI card. + Open the [Fern Dashboard](https://dashboard.buildwithfern.com/). Navigate to the **Settings** tab and click **Enable** on the Ask AI card. Return to this card to [disable Ask Fern](#disable-ask-fern) later. Enabling Ask Fern triggers an automatic reindex of your content. This typically takes a few minutes, though sites with extensive custom components may take longer. Once this process is finished, the Ask Fern side panel will appear on your site. @@ -63,6 +63,20 @@ Ask Fern is Fern's AI Search feature, powered by [Claude 4.6 Sonnet](https://www +## Disable Ask Fern + +To turn Ask Fern off, open the [Fern Dashboard](https://dashboard.buildwithfern.com/), navigate to the **Settings** tab, and click **Disable** on the Ask AI card. This removes AI search and the side panel from your site. There is no `docs.yml` equivalent — the [`ai-search` key](/learn/docs/configuration/site-level-settings#ask-fern-configuration) configures Ask Fern once it's enabled, so setting `ai-search: {}` leaves it running with its default behavior. + +To keep Ask Fern and hide only its page action button, set [`ask-ai`](/learn/docs/configuration/site-level-settings#page-actionsoptions.ask-ai) to `false`: + +```yaml docs.yml +page-actions: + options: + ask-ai: false +``` + +Ask Fern stays reachable everywhere else it appears, including the search bar and the [standalone search widget](/learn/docs/ai-features/ask-fern/search-widget). + ## Features Ask Fern comes with built-in tools to help you understand how users interact with your documentation and ensure answers are accurate and trustworthy. diff --git a/fern/products/docs/pages/customization/search.mdx b/fern/products/docs/pages/customization/search.mdx index 6a094d1db..c840e2ad6 100644 --- a/fern/products/docs/pages/customization/search.mdx +++ b/fern/products/docs/pages/customization/search.mdx @@ -131,3 +131,14 @@ Contact the Fern team to get your specific application ID and index name. Creden ## Using an alternative search You can override Fern's search with your own solution using [custom JavaScript](/learn/docs/building-and-customizing-your-docs/custom-css-global-js#custom-javascript) and your Algolia credentials. + +## Disable search + +Set [`disable-search`](/learn/docs/configuration/site-level-settings#settingsdisable-search) to `true` to remove the search bar from your site: + +```yaml docs.yml +settings: + disable-search: true +``` + +Reach for this when you're replacing Fern's search with your own solution. To keep search working but exclude specific content from results, use [`hidden` and `noindex`](/learn/docs/customization/hiding-content) instead. diff --git a/fern/products/docs/pages/customization/user-feedback.mdx b/fern/products/docs/pages/customization/user-feedback.mdx index 4e0cba03b..210ed6341 100644 --- a/fern/products/docs/pages/customization/user-feedback.mdx +++ b/fern/products/docs/pages/customization/user-feedback.mdx @@ -22,12 +22,21 @@ By default, every Markdown page of your docs contains a feedback component at th -You can also disable this feature for [individual pages](/learn/docs/configuration/page-level-settings#on-page-feedback) or [all pages](/learn/docs/configuration/site-level-settings#layouthide-feedback). - In [self-hosted](/learn/docs/self-hosted/overview) deployments, feedback events are logged as structured JSON to the container's stdout. See [On-page feedback](/learn/docs/self-hosted/set-up#on-page-feedback) for details. +### Disable on-page feedback + +Set [`hide-feedback`](/learn/docs/configuration/site-level-settings#layouthide-feedback) to `true` under `layout` in `docs.yml` to remove the feedback component from every page: + +```yaml docs.yml +layout: + hide-feedback: true +``` + +To remove it from a single page instead, set [`hide-feedback: true`](/learn/docs/configuration/page-level-settings#on-page-feedback) in that page's frontmatter. + ### Viewing feedback in the Dashboard You can view all on-page [feedback responses](/learn/dashboard/getting-started/overview) in the **Feedback** tab of the [Fern Dashboard](https://dashboard.buildwithfern.com/). The table shows feedback per page, including whether the page was helpful and the reason (if provided), plus channel, location, and date. You can filter by date range and export results to CSV. diff --git a/fern/products/docs/pages/navigation/site-level-settings.mdx b/fern/products/docs/pages/navigation/site-level-settings.mdx index ba8cc5d34..c3699b8ef 100644 --- a/fern/products/docs/pages/navigation/site-level-settings.mdx +++ b/fern/products/docs/pages/navigation/site-level-settings.mdx @@ -1199,7 +1199,7 @@ integrations: ## Ask Fern configuration -Specify [Ask Fern](/learn/ask-fern/getting-started/what-is-ask-fern) to control where it appears and what content it can access. +Specify [Ask Fern](/learn/docs/ai-features/ask-fern/overview) to control where it appears and what content it can access. Use these keys to configure Ask Fern once it's enabled. To enable or disable Ask Fern itself, use the **Ask AI** card in the [Fern Dashboard](https://dashboard.buildwithfern.com/) — setting `ai-search: {}` leaves Ask Fern running with its default behavior rather than turning it off. ```yaml docs.yml ai-search: