From 5a5b55853ffc04352ddf3cdd3662a2eeba0e5302 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Tue, 16 Sep 2025 11:45:59 -0400 Subject: [PATCH 1/3] update various pages with info on new ask fern features --- fern/products/ask-fern/pages/features/citations.mdx | 2 ++ fern/products/ask-fern/pages/features/documents.mdx | 12 ++++-------- .../ask-fern/pages/getting-started/how-it-works.mdx | 2 +- .../pages/getting-started/what-is-ask-fern.mdx | 2 +- fern/products/docs/pages/authentication/rbac.mdx | 2 ++ 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/fern/products/ask-fern/pages/features/citations.mdx b/fern/products/ask-fern/pages/features/citations.mdx index cbd31a3fa..c45cd4c20 100644 --- a/fern/products/ask-fern/pages/features/citations.mdx +++ b/fern/products/ask-fern/pages/features/citations.mdx @@ -5,6 +5,8 @@ subtitle: Point users to the exact source of the answer. Fern's AI search includes citations that link directly to source documentation, showing users where information comes from and providing immediate context. By referencing specific documentation sections, citations verify answer sources while enabling users to easily explore topics in greater depth. +When Ask Fern references content from [custom documents added via the Documents API](/ask-fern/configuration/documents), it includes the associated URL as a citation, allowing users to access the original source material. + Ask Fern citations diff --git a/fern/products/ask-fern/pages/features/documents.mdx b/fern/products/ask-fern/pages/features/documents.mdx index 1da2335af..b0a6f0e48 100644 --- a/fern/products/ask-fern/pages/features/documents.mdx +++ b/fern/products/ask-fern/pages/features/documents.mdx @@ -5,17 +5,13 @@ subtitle: Add custom data sources to Ask Fern. ## Overview -You can index custom documents beyond your core documentation to improve Ask Fern's capabilities. -Adding content such as help desk tickets, internal company FAQs, and other resources can help provide better answers to developers. +You can extend Ask Fern's knowledge beyond your core documentation by indexing additional custom content. Adding materials such as internal FAQs, help desk tickets, knowledge base articles, marketing sites, and other resources helps Ask Fern provide more complete answers to developers. -Fern offers an internal CMS (content management system) via the `documents` API that allows you to add, update, -and delete documents as needed. - -See the [API reference](/learn/ask-fern/api-reference/document/create-document) for more details +The Documents API lets you upload, update, and delete custom documents that Ask Fern can reference when responding to user questions. ## Usage -Here's an example of a document that can be uploaded via the `documents` API: +To get started, [upload a document, title, and URL via the Documents API](/learn/ask-fern/api-reference/document/create-document). Here's an example: ```json wordWrap { @@ -25,5 +21,5 @@ Here's an example of a document that can be uploaded via the `documents` API: } ``` -This document will be indexed and made available to Ask Fern as context when users ask questions about ferns. +This document will be indexed and made available to Ask Fern as context when users ask questions about ferns. If Ask Fern references this content in a response, it will include the URL as a citation. diff --git a/fern/products/ask-fern/pages/getting-started/how-it-works.mdx b/fern/products/ask-fern/pages/getting-started/how-it-works.mdx index 572f86a05..acfe053f3 100644 --- a/fern/products/ask-fern/pages/getting-started/how-it-works.mdx +++ b/fern/products/ask-fern/pages/getting-started/how-it-works.mdx @@ -14,7 +14,7 @@ Key behaviors: - **Persistent navigation** – Side panel stays open as users browse different pages or click links provided by the AI responses - **Document-specific queries** – Users can ask questions about the current page through a dropdown option - **Mobile optimization** – Expands to full screen when users start typing on mobile devices -- **Filtering** – Users will get responses that are only related to the product or version they are viewing, or the role they are administered. +- **Filtered responses** – Ask Fern automatically respects versions, products, and roles, so users only see what's relevant to them Ask Fern filtering 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 dcf6586a9..6e244a925 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 @@ -3,7 +3,7 @@ title: What is Ask Fern? 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. +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.