Skip to content

Commit 2d056c9

Browse files
docs: simplify ai-search paramfields and move details to note callouts
Co-Authored-By: [email protected] <[email protected]>
1 parent 82ca9a6 commit 2d056c9

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

fern/products/ask-fern/pages/configuration/locations-and-datasources.mdx

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,23 @@ ai-search:
2020
### Available Locations
2121
2222
<ParamField path="docs" type="string">
23-
Enables Ask Fern on your documentation site. Users will see the AI search interface directly in your docs.
23+
Documentation site
2424
</ParamField>
2525
2626
<ParamField path="slack" type="string">
27-
Enables Ask Fern in Slack. Learn more about the [Slack app integration](/ask-fern/features/slack-app).
27+
Slack workspace
2828
</ParamField>
2929
3030
<ParamField path="discord" type="string">
31-
Enables Ask Fern in Discord. This allows your community to get AI-powered answers in your Discord server.
31+
Discord server
3232
</ParamField>
3333
34+
<Note>
35+
- `docs`: Enables Ask Fern on your documentation site with the AI search interface
36+
- `slack`: Enables Ask Fern in Slack. Learn more about the [Slack app integration](/ask-fern/features/slack-app)
37+
- `discord`: Enables Ask Fern in Discord for community support
38+
</Note>
39+
3440
## Datasources (coming soon)
3541

3642
The `datasources` field allows you to specify additional content sources that Ask Fern should index and search. This is useful when you want to include content from external websites or documentation that isn't part of your main docs.
@@ -47,13 +53,18 @@ ai-search:
4753
### Website Datasources
4854

4955
<ParamField path="url" type="string" required>
50-
The URL of the website to index. Ask Fern will crawl and index the content from this URL.
56+
Website URL to index
5157
</ParamField>
5258

5359
<ParamField path="title" type="string">
54-
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.
60+
Display name for the datasource
5561
</ParamField>
5662

63+
<Note>
64+
- `url`: The website URL that Ask Fern will crawl and index
65+
- `title`: Optional display name shown in citations to help users identify the content source
66+
</Note>
67+
5768
## Preview Environments
5869

5970
Setting `location: [docs]` enables Ask Fern on preview deployments generated with `fern generate --docs --preview`, allowing you to test the AI search functionality before publishing to production.

0 commit comments

Comments
 (0)