Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions fern/products/ask-fern/pages/features/citations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Frame>
<img src="ask-fern-citation.png" alt="Ask Fern citations" />
</Frame>
Expand Down
12 changes: 4 additions & 8 deletions fern/products/ask-fern/pages/features/documents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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, research papers, 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
{
Expand All @@ -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.

Original file line number Diff line number Diff line change
Expand Up @@ -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

<Frame>
<img src="ask-fern-filters.png" alt="Ask Fern filtering" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Frame>
<video
Expand Down
2 changes: 2 additions & 0 deletions fern/products/docs/pages/authentication/rbac.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ description: Learn how to restrict access to your documentation using role-based

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.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great add here!!


### Use cases

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