Skip to content

Commit 758ebda

Browse files
docs: add ai-search configuration to docs.yml reference and update Ask Fern getting started
Co-Authored-By: [email protected] <[email protected]>
1 parent 82ca9a6 commit 758ebda

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Let your customers find answers in your documentation instantly.
55

66
Ask Fern is Fern's AI Search feature that indexes your documentation and provides an interface for your end users to ask questions and get answers. It appears as a side panel on your documentation site so users can ask questions without leaving the page.
77

8-
You can turn Ask Fern on or off via the [Fern Dashboard](https://dashboard.buildwithfern.com/).
8+
You can configure Ask Fern via the [Fern Dashboard](https://dashboard.buildwithfern.com/) or directly in your [`docs.yml` file](/learn/docs/configuration/what-is-docs-yml#ai-search-configuration).
99

1010
<Frame>
1111
<video

fern/products/docs/pages/customization/what-is-docs-yml.mdx

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -619,6 +619,33 @@ analytics:
619619
Your PostHog project API key. Defaults to the api-host of "https://us.i.posthog.com".
620620
</ParamField>
621621

622+
## AI search configuration
623+
624+
Configure [Ask Fern](/learn/ask-fern/getting-started/what-is-ask-fern), Fern's AI-powered search feature, to control where it appears and what content it can access.
625+
626+
```yaml docs.yml
627+
ai-search:
628+
location:
629+
- docs
630+
- slack
631+
- discord
632+
datasources:
633+
- url: https://example.com/additional-docs
634+
title: Additional Documentation
635+
```
636+
637+
<ParamField path="ai-search.location" type="list of strings" required={false} toc={true}>
638+
Specifies where Ask Fern will be available. Options include `docs` (documentation site), `slack` (Slack integration), and `discord` (Discord integration). Learn more about [locations and datasources configuration](/learn/ask-fern/configuration/locations-and-datasources).
639+
</ParamField>
640+
641+
<ParamField path="ai-search.datasources" type="list of objects" required={false} toc={true}>
642+
Additional content sources that Ask Fern should index and search. Each datasource requires a `url` and optional `title`. Learn more about [locations and datasources configuration](/learn/ask-fern/configuration/locations-and-datasources).
643+
</ParamField>
644+
645+
<Note>
646+
Ask Fern can also be configured via the [Fern Dashboard](https://dashboard.buildwithfern.com/). Configuration in `docs.yml` provides version control and allows for preview environment testing.
647+
</Note>
648+
622649
## Dynamic snippets configuration
623650

624651
By default, SDK snippets are static code examples that are displayed in your API Reference. Alternatively, you can use dynamic SDK snippets that allow users to modify parameters and see code examples update in real time.

0 commit comments

Comments
 (0)