Skip to content

Commit 3d48ffc

Browse files
authored
feat: Add Ask Fern documentation & API reference. (#329)
1 parent db43278 commit 3d48ffc

File tree

8 files changed

+48
-2
lines changed

8 files changed

+48
-2
lines changed

fern/products/ask-fern/ask-fern.yml

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,22 @@ navigation:
99
contents:
1010
- page: Custom prompting
1111
path: ./pages/configuration/custom-prompting.mdx
12+
- section: Features
13+
contents:
1214
- page: Citations
13-
path: ./pages/configuration/citations.mdx
15+
path: ./pages/features/citations.mdx
16+
- page: Custom FAQs
17+
path: ./pages/features/custom-faqs.mdx
18+
- api: API Reference
19+
api-name: fai
20+
icon: fa-regular fa-pro
21+
paginated: true
22+
layout:
23+
- page: Overview
24+
path: ./pages/getting-started/api-get-started.mdx
25+
- chat:
26+
- endpoint: chat.chatCompletion
27+
- index:
28+
- endpoint: index.indexDocument
29+
- endpoint: index.getDocument
30+
- endpoint: index.updateDocument
-53 KB
Loading
-42.6 KB
Loading
File renamed without changes.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Custom FAQs
3+
subtitle: Fine-tune your AI search responses.
4+
---
5+
6+
<Markdown src="/snippets/wip-callout.mdx" />
7+
8+
You can add custom FAQs to your documentation to "override" Ask Fern's responses to specific user queries. This is useful for content that you may not wish to display publically, such as billing information, legal terms, and other sensitive content.
9+
10+
Fern offers an internal CMS (content management system) that allows you to add and edit FAQ documents as needed.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: 'Introduction'
3+
subtitle: 'Welcome to the Fern API reference.'
4+
---
5+
6+
<Markdown src="/snippets/pro-callout.mdx" />
7+
8+
The Fern AI API allows you to manage your Ask Fern configuration using Fern's public RESTful API. You can use the API to:
9+
10+
- Build your own support integrations that leverage Ask Fern's AI-powered search
11+
- Add custom context and FAQs to your documentation
12+
- Source usage and analytics data from your Ask Fern instances
13+
14+
## Authentication
15+
16+
Fern API requests require a bearer token for authentication. Use the CLI command [`fern token`](/learn/cli-api/cli-reference/commands#fern-token) to generate a bearer token. Tokens do not expire.

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
@@ -15,7 +15,7 @@ Fern AI Search indexes your documentation and provides an interface for your use
1515
- **Integrate your product faster** - Accelerate implementation with ready-to-use code samples that demonstrate practical applications.
1616
- **Surface where your docs have gaps** - Identify documentation weaknesses through user feedback and search patterns.
1717

18-
<Frame>
18+
<Frame caption="Users can ask questions and get support in an intuitive chat interface.">
1919
<img src="../assets/ask-ai-modal.png" alt="Preview of AI Search" />
2020
</Frame>
2121

fern/snippets/wip-callout.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<Warning title='Work in Progress'>
2+
This feature is currently not yet generally available. Please [email us](mailto:[email protected]) to get started.
3+
</Warning>

0 commit comments

Comments
 (0)