-
Notifications
You must be signed in to change notification settings - Fork 215
Update assistant entry points #1925
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,15 +10,15 @@ | |
|
|
||
| ## About the assistant | ||
|
|
||
| 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. | ||
|
Check warning on line 13 in ai/assistant.mdx
|
||
|
|
||
| The assistant uses agentic RAG (retrieval-augmented generation) with tool calling powered by Claude Sonnet 4.5. When users ask questions, the assistant: | ||
| The assistant uses agentic RAG (retrieval-augmented generation) with tool calling powered by Claude Opus 4.5. When users ask questions, the assistant: | ||
|
Check warning on line 15 in ai/assistant.mdx
|
||
|
|
||
| * **Searches and retrieves** relevant content from your documentation to provide accurate answers. | ||
| * **Cites sources** and provides navigable links to take users directly to referenced pages. | ||
| * **Generates copyable code examples** to help users implement solutions from your documentation. | ||
|
|
||
| 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. | ||
|
|
||
| You can view assistant usage through your dashboard to understand user behavior and documentation effectiveness. Export and analyze query data to help identify: | ||
|
|
||
|
|
@@ -26,20 +26,20 @@ | |
| * Content gaps where users struggle to find answers. | ||
| * Popular topics that could benefit from additional content. | ||
|
|
||
| ## Configuring the assistant | ||
| ## Configure the assistant | ||
|
|
||
| The assistant is enabled by default for Pro and Custom plans. | ||
|
|
||
| Manage the assistant from your [dashboard](https://dashboard.mintlify.com/products/assistant/settings). Click **Configuration** to enable or disable the assistant, configure response handling, add default questions, and set a spend limit. | ||
|
|
||
| <Frame> | ||
| <img src="/images/assistant/configuration-light.png" alt="The assistant toolbar in the dashboard. The Configuration button is emphasized with an orange rectangle." className="block dark:hidden" /> | ||
| <img src="/images/assistant/configuration-dark.png" alt="The assistant toolbar in the dashboard. The Configuration button is emphasized with an orange rectangle." className="hidden dark:block" /> | ||
| </Frame> | ||
|
|
||
| ### Enable or disable the assistant | ||
|
|
||
| Toggle the assistant status to enable or disable the assistant for your documentation site. | ||
|
|
||
| <Frame> | ||
| <img src="/images/assistant/status-light.png" alt="The assistant status toggle in the dashboard." className="block dark:hidden" /> | ||
|
|
@@ -57,7 +57,7 @@ | |
|
|
||
| ### Set deflection email | ||
|
|
||
| In the response handling section, enable the assistant to redirect unanswered questions to your support team. Specify an email address that the assistant provides to users who ask questions that it cannot answer. | ||
|
|
||
| <Frame> | ||
| <img src="/images/assistant/deflection-light.png" alt="The assistant deflection panel in the dashboard. Assistant deflection is toggled on and [email protected] is set as the deflection email." className="block dark:hidden" /> | ||
|
|
@@ -67,13 +67,13 @@ | |
| ### Search sites | ||
|
|
||
| <Note> | ||
| Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:[email protected]). | ||
| Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:[email protected]). | ||
| </Note> | ||
|
|
||
| In the response handling section, configure sites that the assistant can search for additional context when answering questions. | ||
|
|
||
| - Sites must be publicly available. | ||
| - Sites that require JavaScript to load are not supported. | ||
|
|
||
| <Frame> | ||
| <img src="/images/assistant/search-sites-light.png" alt="The assistant search sites panel in the dashboard. The assistant is configured to search the mintlify.com and mintlify.com/blog domains." className="block dark:hidden" /> | ||
|
|
@@ -104,7 +104,7 @@ | |
|
|
||
| Set a spend limit to control what happens if you reach your message allowance. By default, the assistant continues to answer user questions after you reach your message allowance, which incurs overages. | ||
|
|
||
| When you reach your spend limit, the assistant is disabled until your message allowance resets. | ||
|
Check warning on line 107 in ai/assistant.mdx
|
||
|
|
||
| 1. Select the **Billing** tab. | ||
| <Frame> | ||
|
|
@@ -114,33 +114,82 @@ | |
| 2. Set a spend limit for assistant messages beyond your allowance. | ||
| 3. Set usage alerts to receive an email when you reach a certain percentage of your spend limit. | ||
|
|
||
| ## Using the assistant | ||
|
|
||
| Users can access the assistant in three ways: | ||
|
|
||
| - **Keyboard shortcut**: <kbd>Command</kbd> + <kbd>I</kbd> (<kbd>Ctrl</kbd> + <kbd>I</kbd> on Windows) | ||
| - **Assistant button** next to the search bar | ||
| <img | ||
| src="/images/assistant/assistant-button-light.png" | ||
| className="block dark:hidden rounded-2xl border border-gray-100 shadow-lg" | ||
| style={{ | ||
| width: '268px', | ||
| height: 'auto', | ||
| }} | ||
| alt="Search bar and assistant button in light mode." | ||
| /> | ||
| <img | ||
| src="/images/assistant/assistant-button-dark.png" | ||
| className="hidden dark:block rounded-2xl border border-white/10 shadow-lg" | ||
| style={{ | ||
| width: '268px', | ||
| height: 'auto', | ||
| }} | ||
| alt="Search bar and assistant button in dark mode." | ||
| /> | ||
| - **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). | ||
|
|
||
| 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. | ||
| ## Use the assistant | ||
|
|
||
| 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. | ||
|
Check warning on line 119 in ai/assistant.mdx
|
||
|
|
||
| ### UI placement | ||
|
|
||
| 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. | ||
|
|
||
| <Columns cols={2}> | ||
| <Frame caption="Assistant button next to the search bar."> | ||
| <img | ||
| src="/images/assistant/assistant-button-light.png" | ||
| className="block dark:hidden" | ||
| style={{ | ||
| width: '268px', | ||
| height: 'auto', | ||
| }} | ||
| alt="Search bar and assistant button in light mode." | ||
| /> | ||
| <img | ||
| src="/images/assistant/assistant-button-dark.png" | ||
| className="hidden dark:block" | ||
| style={{ | ||
| width: '268px', | ||
| height: 'auto', | ||
| }} | ||
| alt="Search bar and assistant button in dark mode." | ||
| /> | ||
| </Frame> | ||
| <Frame caption="Assistant button at the bottom of the page."> | ||
| <img | ||
| src="/images/assistant/assistant-bar-light.png" | ||
| className="block dark:hidden" | ||
| style={{ | ||
| width: '268px', | ||
| height: 'auto', | ||
| }} | ||
| alt="Assistant bar in light mode." | ||
| /> | ||
| <img | ||
| src="/images/assistant/assistant-bar-dark.png" | ||
| className="hidden dark:block" | ||
| style={{ | ||
| width: '268px', | ||
| height: 'auto', | ||
| }} | ||
| alt="Assistant bar in dark mode." | ||
| /> | ||
| </Frame> | ||
| </Columns> | ||
|
|
||
| ### Keyboard shortcut | ||
|
|
||
| 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. | ||
|
|
||
| ### Highlight text | ||
|
|
||
| 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. | ||
|
|
||
| <Frame> | ||
| <img src="/images/assistant/highlight-light.png" alt="The Add to assistant button above highlighted text in light mode." className="block dark:hidden" /> | ||
| <img src="/images/assistant/highlight-dark.png" alt="The Add to assistant button above highlighted text in dark mode." className="hidden dark:block" /> | ||
| </Frame> | ||
|
|
||
| ### Code blocks | ||
|
|
||
| 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. | ||
|
|
||
| <Frame> | ||
| <img src="/images/assistant/code-block-light.png" alt="The Ask AI button in a code block in light mode." className="block dark:hidden" /> | ||
| <img src="/images/assistant/code-block-dark.png" alt="The Ask AI button in a code block in dark mode." className="hidden dark:block" /> | ||
| </Frame> | ||
|
|
||
| ### URLs | ||
|
|
||
| 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). | ||
|
|
||
| ## Making content AI ingestible | ||
|
|
||
|
|
@@ -171,7 +220,7 @@ | |
| - Discover user behavior patterns and common information needs from themes and patterns in queries. | ||
| - Prioritize high-traffic pages for accuracy and quality improvements. | ||
|
|
||
| You can explore queries from your [dashboard](https://dashboard.mintlify.com/products/assistant), but to get more powerful insights we recommend exporting a `CSV` file of your queries, responses, and sources to analyze with your preferred AI tool. | ||
|
|
||
| 1. Navigate to the [assistant page](https://dashboard.mintlify.com/products/assistant) in your dashboard. | ||
| 2. Select **Export to CSV**. | ||
|
|
@@ -188,7 +237,7 @@ | |
|
|
||
| ### Categories | ||
|
|
||
| The categories tab uses LLMs to automatically categorize conversations by question topic and theme. Conversations are organized by the most common groupings, helping you quickly identify: | ||
| - Which topics generate the most questions | ||
| - Patterns in user needs and behavior | ||
| - Areas where documentation might need expansion or clarification | ||
|
|
@@ -202,8 +251,8 @@ | |
| ## Troubleshooting | ||
|
|
||
| <Accordion title="Assistant chat bar not visible"> | ||
| If the assistant UI is not visible in specific browsers, you may need to submit a false positive report to [EasyList](https://easylist.to). Browsers that use the EasyList Cookies List like Brave and Comet sometimes block the assistant or other UI elements. The EasyList Cookies List includes a domain-specific rule that hides fixed elements on certain domains to block cookie banners. This rule inadvertently affects legitimate UI components. | ||
|
|
||
| Submit a false positive report to [EasyList](https://github.com/easylist/easylist) to request removal of the rule. This resolves the issue for all users once the filter list is updated. | ||
|
|
||
| </Accordion> | ||
Uh oh!
There was an error while loading. Please reload this page.