diff --git a/fern/docs.yml b/fern/docs.yml index 752dd2fa7..48bfbc35d 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -466,6 +466,8 @@ redirects: destination: /learn/ask-fern/features/citations - source: /learn/ask-fern/custom-prompting destination: /learn/ask-fern/configuration/custom-prompts + - source: /learn/ask-fern/configuration/locations-and-datasources + destination: /learn/ask-fern/configuration/setup # General Ask Fern patterns - source: /learn/ai-search/getting-started/:slug* diff --git a/fern/products/ask-fern/ask-fern.yml b/fern/products/ask-fern/ask-fern.yml index 5415b8d6b..bcfc656a7 100644 --- a/fern/products/ask-fern/ask-fern.yml +++ b/fern/products/ask-fern/ask-fern.yml @@ -9,10 +9,11 @@ navigation: href: https://buildwithfern.com/showcase#ask-fern-customers - section: Configuration contents: + - page: Setup + path: ./pages/configuration/locations-and-datasources.mdx + slug: setup - page: Custom prompts path: ./pages/configuration/custom-prompting.mdx - - page: Locations and datasources - path: ./pages/configuration/locations-and-datasources.mdx - page: Guidance path: ./pages/features/guidance.mdx - page: Documents diff --git a/fern/products/ask-fern/pages/configuration/locations-and-datasources.mdx b/fern/products/ask-fern/pages/configuration/locations-and-datasources.mdx index 6fd775ec5..8723b5475 100644 --- a/fern/products/ask-fern/pages/configuration/locations-and-datasources.mdx +++ b/fern/products/ask-fern/pages/configuration/locations-and-datasources.mdx @@ -1,83 +1,20 @@ --- -title: Locations and datasources +title: Setup subtitle: Configure where Ask Fern is available and what content it can access. +max-toc-depth: 2 --- -Ask Fern can be configured to appear in multiple locations and pull content from various datasources. This allows you to provide AI-powered assistance wherever your users need it and ensure access to relevant information. +## Basic setup -## Locations - -The `location` field in your `ai-search` configuration determines where Ask Fern will be available to your users. You can specify one or more locations: +Enable Ask Fern by adding the `ai-search` configuration to your `docs.yml` file: ```yaml docs.yml ai-search: location: - docs - slack - - discord -``` - -### Available locations - - - Enables Ask Fern on your documentation site. Users will see the AI search interface directly in your docs. - - - - Enables Ask Fern in Slack. Learn more about the [Slack app integration](/ask-fern/features/slack-app). - - - - Enables Ask Fern in Discord. This allows your community to get AI-powered answers in your Discord server. - - -## 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. - -```yaml docs.yml -ai-search: - datasources: - - url: https://example.com/additional-docs - title: Additional Documentation - - url: https://blog.example.com - title: Company Blog ``` -### Website datasources - - - The URL of the website to index. Ask Fern will crawl and index the content from this URL. - - - - 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. - - -## 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. - - - Preview environments don't interfere with your production Ask Fern deployment. - - -## Best practices - - - - Begin by enabling Ask Fern on your documentation site (`location: [docs]`) to test and refine the experience before expanding to other channels like Slack or Discord. - - - - Always provide a `title` for your datasources. This helps users understand the source of information when Ask Fern provides citations. - - - - Only include datasources that contain information relevant to your users' questions. Too many datasources can dilute the quality of search results. - +## Configuration - - Use preview deployments to test your Ask Fern configuration, including locations and datasources, before deploying to production. - - + \ No newline at end of file diff --git a/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx b/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx index d236e392e..143b04687 100644 --- a/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx +++ b/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx @@ -5,8 +5,6 @@ description: Let your customers find answers in your documentation instantly. 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. -You can turn Ask Fern on or off via the [Fern Dashboard](https://dashboard.buildwithfern.com/). -