Skip to content

Commit cad2421

Browse files
committed
cleanup
1 parent 53d40fe commit cad2421

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

chat.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@ description: "Learn how the AI Chat feature uses your docs as context to answer
1111

1212
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.
1313

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>
14+
<Frame caption="The AI Chat interface within the search bar.">
15+
![Screenshot of the AI Chat interface within the Mintlify search bar, showing a question and answer.](/images/ai-chat.png)
1716
</Frame>
1817

1918
**Benefits:**
@@ -31,7 +30,7 @@ It also takes into account the end-user's selected version and language and filt
3130

3231
To ensure the AI Chat Assistant provides the best possible answers to end-users, consider these content strategies:
3332

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.
33+
- **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 guide](search.mdx) for details.
3534
- **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.
3635
- **Consider FAQ Pages:** Adding FAQ pages can provide pre-packaged Q&A pairs that the LLM can easily use.
3736
- **Use Summaries:** For long or complex pages, a brief summary paragraph at the start or end helps the LLM answer high-level questions accurately.
File renamed without changes.

0 commit comments

Comments
 (0)