Skip to content

docs: simplify ai-search paramfields and move details to note callouts #1305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

docs: simplify ai-search paramfields and move details to note callouts #1305

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions fern/products/ask-fern/pages/configuration/locations-and-datasources.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,23 @@
### Available Locations

<ParamField path="docs" type="string">
Enables Ask Fern on your documentation site. Users will see the AI search interface directly in your docs.
Documentation site
</ParamField>

<ParamField path="slack" type="string">
Enables Ask Fern in Slack. Learn more about the [Slack app integration](/ask-fern/features/slack-app).
Slack workspace
</ParamField>

<ParamField path="discord" type="string">
Enables Ask Fern in Discord. This allows your community to get AI-powered answers in your Discord server.
Discord server
</ParamField>

<Note>
- `docs`: Enables Ask Fern on your documentation site with the AI search interface
- `slack`: Enables Ask Fern in Slack. Learn more about the [Slack app integration](/ask-fern/features/slack-app)
- `discord`: Enables Ask Fern in Discord for community support
</Note>

## Datasources (coming soon)

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.
Expand All @@ -47,13 +53,18 @@
### Website Datasources

<ParamField path="url" type="string" required>
The URL of the website to index. Ask Fern will crawl and index the content from this URL.
Website URL to index

Check warning on line 56 in fern/products/ask-fern/pages/configuration/locations-and-datasources.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.GeneralURL] For a general audience, use 'address' rather than 'URL'.

Raw Output:
{"message": "[Microsoft.GeneralURL] For a general audience, use 'address' rather than 'URL'.", "location": {"path": "fern/products/ask-fern/pages/configuration/locations-and-datasources.mdx", "range": {"start": {"line": 56, "column": 11}}}, "severity": "WARNING"}
</ParamField>

<ParamField path="title" type="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.
Display name for the datasource
</ParamField>

<Note>
- `url`: The website URL that Ask Fern will crawl and index

Check warning on line 64 in fern/products/ask-fern/pages/configuration/locations-and-datasources.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.GeneralURL] For a general audience, use 'address' rather than 'URL'.

Raw Output:
{"message": "[Microsoft.GeneralURL] For a general audience, use 'address' rather than 'URL'.", "location": {"path": "fern/products/ask-fern/pages/configuration/locations-and-datasources.mdx", "range": {"start": {"line": 64, "column": 24}}}, "severity": "WARNING"}
- `title`: Optional display name shown in citations to help users identify the content source
</Note>

## Preview Environments

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.
Expand Down