Skip to content

Commit b522b17

Browse files
Documentation edits made through Mintlify web editor
1 parent 4d57893 commit b522b17

File tree

1 file changed

+30
-24
lines changed

1 file changed

+30
-24
lines changed

guides/assistant.mdx

Lines changed: 30 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ The assistant answers questions about your documentation through natural languag
1414

1515
The assistant uses agentic RAG (retrieval-augmented generation) with tool calling powered by Claude Sonnet 4. When users ask questions, the assistant:
1616

17-
* **Searches and retrieves** relevant content from your documentation to provide accurate answers.
18-
* **Cites sources** and provides navigable links to take users directly to referenced pages.
19-
* **Generates copyable code examples** to help users implement solutions from your documentation.
17+
- **Searches and retrieves** relevant content from your documentation to provide accurate answers.
18+
- **Cites sources** and provides navigable links to take users directly to referenced pages.
19+
- **Generates copyable code examples** to help users implement solutions from your documentation.
2020

2121
Each message sent to the assistant counts toward your plan's message allowance. If you exceed your allowance, additional messages incur overage charges. You can set spending limits or disable the assistant if you reach your message allowance.
2222

2323
You can view assistant usage through your dashboard to understand user behavior and documentation effectiveness. Export and analyze query data to help identify:
2424

25-
* Frequently asked questions that might need better coverage.
26-
* Content gaps where users struggle to find answers.
27-
* Popular topics that could benefit from additional content.
25+
- Frequently asked questions that might need better coverage.
26+
- Content gaps where users struggle to find answers.
27+
- Popular topics that could benefit from additional content.
2828

2929
## Configuring the assistant
3030

@@ -34,15 +34,15 @@ The assistant is enabled by default for Pro and Custom plans. You can manage the
3434

3535
Toggle the assistant status to enable or disable the assistant for your documentation site.
3636

37-
### Response handling
37+
### Response customization
3838

39-
Configure how the assistant responds when it cannot find answers in your documentation. You can redirect unanswered questions to your support team and enable the assistant to search external websites.
39+
When the assistant cannot find answers in your documentation, you can surface your support team email to redirect users.
4040

41-
- **Assistant Deflection**: When enabled, the assistant directs users to your support team for questions that it cannot answer.
42-
- **Search Sites**: The assistant can search specified external sites for additional context when answering questions.
43-
<Note>
44-
Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:[email protected]).
45-
</Note>
41+
To provide additional context when answering questions, you can enable the assistant to search external sites such as your blog, pricing page, or partner integration docs.
42+
43+
<Info>
44+
Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:[email protected]).
45+
</Info>
4646

4747
### Spend limit
4848

@@ -56,27 +56,33 @@ You can also set usage alerts to receive an email when you reach a certain perce
5656

5757
Users can access the assistant in three ways:
5858

59-
- **Keyboard shortcuts**: <kbd>?</kbd> or <kbd>Command</kbd> + <kbd>I</kbd> (<kbd>Ctrl</kbd> + <kbd>I</kbd> on Windows)
59+
- **Keyboard shortcuts**: <kbd>?</kbd>
60+
61+
or <kbd>Command</kbd>
62+
63+
\+ <kbd>I</kbd>
64+
65+
(<kbd>Ctrl</kbd>
66+
67+
\+ <kbd>I</kbd>
68+
69+
on Windows)
6070
- **Assistant button** next to the search bar
71+
6172
<img
6273
src="/images/assistant/assistant-button-light.png"
6374
className="block dark:hidden rounded-2xl border border-gray-100 shadow-lg"
64-
style={{
65-
width: '268px',
66-
height: 'auto',
67-
}}
75+
style={{ width:"268px",height:"auto" }}
6876
alt="Search bar and assistant button in light mode."
6977
/>
78+
7079
<img
7180
src="/images/assistant/assistant-button-dark.png"
7281
className="hidden dark:block rounded-2xl border border-white/10 shadow-lg"
73-
style={{
74-
width: '268px',
75-
height: 'auto',
76-
}}
82+
style={{ width:"268px",height:"auto" }}
7783
alt="Search bar and assistant button in dark mode."
7884
/>
79-
- **URLs** with `?assistant=open` appended will open the assistant when the page loads. For example, [https://mintlify.com/docs?assistant=open](https://mintlify.com/docs?assistant=open).
85+
- **URLs** with `?assistant=open` appended will open the assistant when the page loads. For example, https://mintlify.com/docs?assistant=open.
8086

8187
Both methods open a chat panel on the right side of your docs. Users can ask any question and the assistant will search your documentation for an answer. If no relevant information is found, the assistant will respond that it cannot answer the question.
8288

@@ -119,4 +125,4 @@ You can explore queries from your [dashboard](https://dashboard.mintlify.com/pro
119125
- Summarize the most common themes of the queries.
120126
- List any queries that had no sources cited.
121127
- Find patterns in unsuccessful interactions.
122-
</Card>
128+
</Card>

0 commit comments

Comments
 (0)