Skip to content

Commit c5882ce

Browse files
authored
Update assistant entry points (#1925)
* update model * add floating bubble entry point * update entry points * update image
1 parent 1ae977c commit c5882ce

File tree

7 files changed

+79
-30
lines changed

7 files changed

+79
-30
lines changed

ai/assistant.mdx

Lines changed: 79 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ keywords: ["chat", "RAG", "user support"]
1212

1313
The assistant answers questions about your documentation through natural language queries. It is embedded directly in your documentation site, so users can find answers quickly and succeed with your product.
1414

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

1717
* **Searches and retrieves** relevant content from your documentation to provide accurate answers.
1818
* **Cites sources** and provides navigable links to take users directly to referenced pages.
@@ -26,7 +26,7 @@ You can view assistant usage through your dashboard to understand user behavior
2626
* Content gaps where users struggle to find answers.
2727
* Popular topics that could benefit from additional content.
2828

29-
## Configuring the assistant
29+
## Configure the assistant
3030

3131
The assistant is enabled by default for Pro and Custom plans.
3232

@@ -67,7 +67,7 @@ In the response handling section, enable the assistant to redirect unanswered qu
6767
### Search sites
6868

6969
<Note>
70-
Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:gtm@mintlify.com).
70+
Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:gtm@mintlify.com).
7171
</Note>
7272

7373
In the response handling section, configure sites that the assistant can search for additional context when answering questions.
@@ -114,33 +114,82 @@ When you reach your spend limit, the assistant is disabled until your message al
114114
2. Set a spend limit for assistant messages beyond your allowance.
115115
3. Set usage alerts to receive an email when you reach a certain percentage of your spend limit.
116116

117-
## Using the assistant
118-
119-
Users can access the assistant in three ways:
120-
121-
- **Keyboard shortcut**: <kbd>Command</kbd> + <kbd>I</kbd> (<kbd>Ctrl</kbd> + <kbd>I</kbd> on Windows)
122-
- **Assistant button** next to the search bar
123-
<img
124-
src="/images/assistant/assistant-button-light.png"
125-
className="block dark:hidden rounded-2xl border border-gray-100 shadow-lg"
126-
style={{
127-
width: '268px',
128-
height: 'auto',
129-
}}
130-
alt="Search bar and assistant button in light mode."
131-
/>
132-
<img
133-
src="/images/assistant/assistant-button-dark.png"
134-
className="hidden dark:block rounded-2xl border border-white/10 shadow-lg"
135-
style={{
136-
width: '268px',
137-
height: 'auto',
138-
}}
139-
alt="Search bar and assistant button in dark mode."
140-
/>
141-
- **URLs** with `?assistant=open` appended open the assistant when the page loads. For example, [https://mintlify.com/docs?assistant=open](https://mintlify.com/docs?assistant=open).
142-
143-
Each method opens a chat panel on the right side of your docs. Users can ask any question and the assistant searches your documentation for an answer. If no relevant information is found, the assistant responds that it cannot answer the question.
117+
## Use the assistant
118+
119+
Users have multiple ways to start a conversation with the assistant. Each method opens a chat panel on the right side of your docs. Users can ask any question and the assistant searches your documentation for an answer. If no relevant information is found, the assistant responds that it cannot answer the question.
120+
121+
### UI placement
122+
123+
Depending on how you configure your assistant placement, the assistant appears as either a button next to the search bar or a bar at the bottom of the page.
124+
125+
<Columns cols={2}>
126+
<Frame caption="Assistant button next to the search bar.">
127+
<img
128+
src="/images/assistant/assistant-button-light.png"
129+
className="block dark:hidden"
130+
style={{
131+
width: '268px',
132+
height: 'auto',
133+
}}
134+
alt="Search bar and assistant button in light mode."
135+
/>
136+
<img
137+
src="/images/assistant/assistant-button-dark.png"
138+
className="hidden dark:block"
139+
style={{
140+
width: '268px',
141+
height: 'auto',
142+
}}
143+
alt="Search bar and assistant button in dark mode."
144+
/>
145+
</Frame>
146+
<Frame caption="Assistant button at the bottom of the page.">
147+
<img
148+
src="/images/assistant/assistant-bar-light.png"
149+
className="block dark:hidden"
150+
style={{
151+
width: '268px',
152+
height: 'auto',
153+
}}
154+
alt="Assistant bar in light mode."
155+
/>
156+
<img
157+
src="/images/assistant/assistant-bar-dark.png"
158+
className="hidden dark:block"
159+
style={{
160+
width: '268px',
161+
height: 'auto',
162+
}}
163+
alt="Assistant bar in dark mode."
164+
/>
165+
</Frame>
166+
</Columns>
167+
168+
### Keyboard shortcut
169+
170+
Open the assistant chat panel with the keyboard shortcut <kbd>Command</kbd> + <kbd>I</kbd> on macOS and <kbd>Ctrl</kbd> + <kbd>I</kbd> on Windows.
171+
172+
### Highlight text
173+
174+
Highlight text on a page and click the **Add to assistant** pop up button to open the assistant chat panel and add the highlighted text as context. You can add multiple text snippets or code blocks to the assistant's context.
175+
176+
<Frame>
177+
<img src="/images/assistant/highlight-light.png" alt="The Add to assistant button above highlighted text in light mode." className="block dark:hidden" />
178+
<img src="/images/assistant/highlight-dark.png" alt="The Add to assistant button above highlighted text in dark mode." className="hidden dark:block" />
179+
</Frame>
180+
181+
### Code blocks
182+
183+
Click the **Ask AI** button in a code block to open the assistant chat panel and add the code block as context. You can add multiple code blocks or text snippets to the assistant's context.
184+
185+
<Frame>
186+
<img src="/images/assistant/code-block-light.png" alt="The Ask AI button in a code block in light mode." className="block dark:hidden" />
187+
<img src="/images/assistant/code-block-dark.png" alt="The Ask AI button in a code block in dark mode." className="hidden dark:block" />
188+
</Frame>
189+
190+
### URLs
191+
192+
Append `?assistant=open` to a URL to open the assistant when the page loads. For example, [https://mintlify.com/docs?assistant=open](https://mintlify.com/docs?assistant=open).
144193

145194
## Making content AI ingestible
146195

13.8 KB
Loading
14.4 KB
Loading
63.5 KB
Loading
62.7 KB
Loading
40.5 KB
Loading
43.1 KB
Loading

0 commit comments

Comments
 (0)