Skip to content

Commit 0998079

Browse files
committed
Documentation edits made through Mintlify web editor
1 parent c451053 commit 0998079

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

ai-chat.png

174 KB
Loading

chat.mdx

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "AI Chat"
3+
description: "Learn how the AI Chat feature uses your docs as context to answer end-user questions"
4+
---
5+
6+
<Info>
7+
AI Chat is available on the Pro plan and up.
8+
</Info>
9+
10+
## Overview
11+
12+
The AI Chat feature, embedded in the search bar, allows end-users to get help via a chat interface instead of using full-text search or navigating manually through your documentation.
13+
14+
<Frame>
15+
![Screenshot of the AI Chat interface within the Mintlify search bar, showing a question and answer.](/ai-chat.png)
16+
<Caption>The AI Chat interface within the search bar.</Caption>
17+
</Frame>
18+
19+
**Benefits:**
20+
21+
- **For End-Users:** Allows them to ask specific questions about your product/service and receive instant answers sourced directly from your documentation.
22+
- **For Documentation Maintainers:** Helps reduce the load on your support teams by addressing common questions and improves engagement with your documentation.
23+
24+
## How it Uses Your Documentation
25+
26+
AI Chat uses only the content published on your docs as its knowledge base. We designed it to use your documentation as the single source of truth and avoid hallucinating answers that are not supported by your content.
27+
28+
It also takes into account the end-user's selected version and language and filters the sources it uses as context based on these factors.
29+
30+
## Optimizing Your Content for AI Chat
31+
32+
To ensure the AI Chat Assistant provides the best possible answers to end-users, consider these content strategies:
33+
34+
- **Follow Search Best Practices:** Optimizing for traditional search is the first step. Ensure your documentation uses clear headings, logical structure, focused sections, and natural keyword inclusion. Refer to our [Search Optimization Guide](search.mdx) for details.
35+
- **Write Explicitly & Answer Questions:** Phrase content clearly and directly answer anticipated end-user questions. Instead of just describing features, explain _how_ to use them or what settings do. This gives the LLM direct context to formulate answers.
36+
- **Consider FAQ Pages:** Adding FAQ pages can provide pre-packaged Q&A pairs that the LLM can easily use.
37+
- **Use Summaries:** For long or complex pages, a brief summary paragraph at the start or end helps the LLM answer high-level questions accurately.
38+
- **Define Key Terms Clearly:** Ensure you define product-specific jargon, acronyms, or technical terms inline or in a glossary.
39+
- **Maintain Consistency:** Use consistent terminology for the same concepts throughout your docs to avoid ambiguity.
40+
- **Structure Data Clearly:** Use tables or definition lists for structured data like parameters or error codes, making them easier for the AI to parse accurately.

0 commit comments

Comments
 (0)