Configuration

Setup

Configure where Ask Fern is available and what content it can access.

Basic setup

Enable Ask Fern by adding the ai-search configuration to your docs.yml file:

docs.yml
1ai-search:
2  location:
3    - docs
4    - slack

Configuration

docs.yml
1ai-search:
2  location:
3    - docs
4    - slack
5    - discord
6  datasources:
7    - url: https://example.com/additional-docs
8      title: Additional documentation
9    - url: https://blog.example.com
10      title: Company blog
ai-search.location
list of strings

Specifies where Ask Fern will be available. Options:

  • docs enables Ask Fern on your documentation site
  • slack enables Ask Fern in Slack
  • discord enables Ask Fern in Discord

Most users should enable Ask Fern for both docs and either slack or discord.

ai-search.datasources
list of objects

Additional content sources that Ask Fern should index and search.

datasources.url
stringRequired

The URL of the website to index. Ask Fern will crawl and index the content from this URL.

datasources.title
string

An optional display name for this datasource. This helps users understand where the information is coming from when Ask Fern cites content from this source.