Skip to content

Commit 924ff93

Browse files
devin-ai-integration[bot]bot_apkdevalog
authored
docs: document all available search filter options (#4567)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: bot_apk <apk@cognition.ai> Co-authored-by: Devin Logan <devinannlogan@gmail.com>
1 parent 4036036 commit 924ff93

3 files changed

Lines changed: 23 additions & 13 deletions

File tree

-143 KB
Loading

fern/products/docs/pages/customization/search.mdx

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,41 @@
11
---
22
title: Search configuration
3-
description: Configure search for your Fern docs using Algolia DocSearch. Filter by versions, endpoints, guides, and changelogs for better user experience.
3+
description: Configure search for your Fern docs using Algolia DocSearch. Filter by product, version, content type, API type, HTTP method, status code, and availability.
44
---
55

66
<Markdown src="/snippets/agent-directive.mdx"/>
77

88
Fern uses [Algolia DocSearch](https://docsearch.algolia.com/) to power search for your documentation.
9-
DocSearch is designed specifically for documentation sites to help users quickly find what they need.
9+
DocSearch is designed specifically for documentation sites to help users find what they need.
1010

1111
## How search works
1212

1313
DocSearch scans your Fern site's content and builds an index to generate search results.
14-
It includes built-in filters that let users refine their searches by content type:
15-
16-
- **Versions:** For sites with separate documentation for different API versions
17-
- **Endpoints:** Filters results by API reference documentation
18-
- **Guides:** Filters results by non-API reference documentation
19-
- **Changelog:** Filters results by changelog updates
14+
It includes built-in dropdown filters that appear dynamically based on your site's configuration, letting users refine their searches:
15+
16+
- **Product:** Narrows results to a specific product in your documentation (for sites with multiple [products](/learn/docs/configuration/products))
17+
- **Version:** Filters results by documentation version (for sites using [versioned docs](/learn/docs/configuration/versions))
18+
- **Content type:** Filters results by guides, changelog entries, or API endpoints
19+
- **API type:** Filters API results by protocol (HTTP, webhooks, WebSockets, or gRPC)
20+
- **HTTP method:** Filters API results by HTTP method (`GET`, `POST`, `PUT`, `DELETE`, etc.)
21+
- **Status code:** Filters API results by HTTP status code
22+
- **Availability:** Filters API results by availability status, including Stable, Beta, and Deprecated
23+
24+
<Frame caption="Fern's own docs site shows Product, Content type, and HTTP method filters. Other filters, like Version, don't appear because this site doesn't use versioned docs.">
25+
<video
26+
src="search.mp4"
27+
autoPlay
28+
loop
29+
playsInline
30+
muted
31+
>
32+
</video>
33+
</Frame>
2034

2135
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.
2236

23-
<Frame>
24-
<img src="./filtering.png" />
25-
</Frame>
26-
2737
<Note>
28-
**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.
38+
**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.
2939
</Note>
3040

3141
## Integrating with Algolia
1.3 MB
Binary file not shown.

0 commit comments

Comments
 (0)