Skip to content

Commit c840c49

Browse files
authored
(docs, ask fern) Update various pages to align with new Ask Fern features (#826)
1 parent 1d3374b commit c840c49

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

fern/products/ask-fern/pages/features/citations.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ subtitle: Point users to the exact source of the answer.
55

66
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.
77

8+
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.
9+
810
<Frame>
911
<img src="ask-fern-citation.png" alt="Ask Fern citations" />
1012
</Frame>

fern/products/ask-fern/pages/features/documents.mdx

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,13 @@ subtitle: Add custom data sources to Ask Fern.
55

66
## Overview
77

8-
You can index custom documents beyond your core documentation to improve Ask Fern's capabilities.
9-
Adding content such as help desk tickets, internal company FAQs, and other resources can help provide better answers to developers.
8+
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, research papers, and other resources helps Ask Fern provide more complete answers to developers.
109

11-
Fern offers an internal CMS (content management system) via the `documents` API that allows you to add, update,
12-
and delete documents as needed.
13-
14-
See the [API reference](/learn/ask-fern/api-reference/document/create-document) for more details
10+
The Documents API lets you upload, update, and delete custom documents that Ask Fern can reference when responding to user questions.
1511

1612
## Usage
1713

18-
Here's an example of a document that can be uploaded via the `documents` API:
14+
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:
1915

2016
```json wordWrap
2117
{
@@ -25,5 +21,5 @@ Here's an example of a document that can be uploaded via the `documents` API:
2521
}
2622
```
2723

28-
This document will be indexed and made available to Ask Fern as context when users ask questions about ferns.
24+
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.
2925

fern/products/ask-fern/pages/getting-started/how-it-works.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Key behaviors:
1414
- **Persistent navigation** – Side panel stays open as users browse different pages or click links provided by the AI responses
1515
- **Document-specific queries** – Users can ask questions about the current page through a dropdown option
1616
- **Mobile optimization** – Expands to full screen when users start typing on mobile devices
17-
- **Filtering**Users will get responses that are only related to the product or version they are viewing, or the role they are administered.
17+
- **Filtered responses**Ask Fern automatically respects versions, products, and roles, so users only see what's relevant to them
1818

1919
<Frame>
2020
<img src="ask-fern-filters.png" alt="Ask Fern filtering" />

fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: What is Ask Fern?
33
description: Let your customers find answers in your documentation instantly.
44
---
55

6-
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.
6+
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.
77

88
<Frame>
99
<video

fern/products/docs/pages/authentication/rbac.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ description: Learn how to restrict access to your documentation using role-based
1010

1111
Fern allows you to restrict parts of your navigation to individuals with specific roles. RBAC enables you to create different levels of access for different user types within your documentation.
1212

13+
When RBAC is configured, [Ask Fern](/ask-fern/getting-started/how-it-works) automatically respects these permissions so users only receive answers from content they're authorized to view.
14+
1315
### Use cases
1416

1517
Role-based access control is helpful for scenarios such as:

0 commit comments

Comments
 (0)