diff --git a/fern/products/docs/pages/customization/filtering.png b/fern/products/docs/pages/customization/filtering.png index 15df3d489..03897153c 100644 Binary files a/fern/products/docs/pages/customization/filtering.png and b/fern/products/docs/pages/customization/filtering.png differ diff --git a/fern/products/docs/pages/customization/search.mdx b/fern/products/docs/pages/customization/search.mdx index 4a4bc4422..37e000adc 100644 --- a/fern/products/docs/pages/customization/search.mdx +++ b/fern/products/docs/pages/customization/search.mdx @@ -1,31 +1,41 @@ --- title: Search configuration -description: Configure search for your Fern docs using Algolia DocSearch. Filter by versions, endpoints, guides, and changelogs for better user experience. +description: Configure search for your Fern docs using Algolia DocSearch. Filter by product, version, content type, API type, HTTP method, status code, and availability. --- Fern uses [Algolia DocSearch](https://docsearch.algolia.com/) to power search for your documentation. -DocSearch is designed specifically for documentation sites to help users quickly find what they need. +DocSearch is designed specifically for documentation sites to help users find what they need. ## How search works DocSearch scans your Fern site's content and builds an index to generate search results. -It includes built-in filters that let users refine their searches by content type: - -- **Versions:** For sites with separate documentation for different API versions -- **Endpoints:** Filters results by API reference documentation -- **Guides:** Filters results by non-API reference documentation -- **Changelog:** Filters results by changelog updates +It includes built-in dropdown filters that appear dynamically based on your site's configuration, letting users refine their searches: + +- **Product:** Narrows results to a specific product in your documentation (for sites with multiple [products](/learn/docs/configuration/products)) +- **Version:** Filters results by documentation version (for sites using [versioned docs](/learn/docs/configuration/versions)) +- **Content type:** Filters results by guides, changelog entries, or API endpoints +- **API type:** Filters API results by protocol (HTTP, webhooks, WebSockets, or gRPC) +- **HTTP method:** Filters API results by HTTP method (`GET`, `POST`, `PUT`, `DELETE`, etc.) +- **Status code:** Filters API results by HTTP status code +- **Availability:** Filters API results by availability status, including Stable, Beta, and Deprecated + + + + If you're using [Ask Fern](/learn/docs/ai-features/ask-fern/overview) (AI search), the search box also functions as your site's chat window. - - - - - **Note:** If an article includes the `nofollow` or `noindex` [frontmatter](/learn/docs/configuration/page-level-settings#indexing-properties), it will not be indexed by Algolia DocSearch and won't appear in search results. + **Note:** If an article includes the `nofollow` or `noindex` [frontmatter](/learn/docs/configuration/page-level-settings#indexing-properties), it won't be indexed by Algolia DocSearch and won't appear in search results. ## Integrating with Algolia diff --git a/fern/products/docs/pages/customization/search.mp4 b/fern/products/docs/pages/customization/search.mp4 new file mode 100644 index 000000000..3fa53a5b9 Binary files /dev/null and b/fern/products/docs/pages/customization/search.mp4 differ