Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion ai/assistant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L13

Use 'it's' instead of 'It is'.

Check warning on line 13 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L13

In general, use active voice instead of passive voice ('is embedded').

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

Check warning on line 15 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L15

Spell out 'RAG', if it's unfamiliar to the audience.

Check warning on line 15 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L15

Use parentheses judiciously.

* **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.

Check warning on line 21 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L21

Use 'turn off' or 'off' instead of 'disable'.

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

Expand All @@ -28,18 +28,18 @@

## Configure the assistant

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

Check warning on line 31 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L31

In general, use active voice instead of passive voice ('is enabled').

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.

Check warning on line 33 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L33

Use 'turn off' or 'off' instead of 'disable'.

<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

Check warning on line 40 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L40

Use 'turn off' or 'off' instead of 'disable'.

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

Check warning on line 42 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L42

Use 'turn off' or 'off' instead of 'disable'.

<Frame>
<img src="/images/assistant/status-light.png" alt="The assistant status toggle in the dashboard." className="block dark:hidden" />
Expand All @@ -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.

Check warning on line 60 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L60

Use 'can't' instead of 'cannot'.

<Frame>
<img src="/images/assistant/deflection-light.png" alt="The assistant deflection panel in the dashboard. Assistant deflection is toggled on and support@mintlify.com is set as the deflection email." className="block dark:hidden" />
Expand All @@ -73,7 +73,7 @@
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.

Check warning on line 76 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L76

Use 'aren't' instead of 'are not'.

<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" />
Expand Down Expand Up @@ -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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L107

In general, use active voice instead of passive voice ('is disabled').

Check warning on line 107 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L107

Use 'turn off' or 'off' instead of 'disabled'.

1. Select the **Billing** tab.
<Frame>
Expand All @@ -116,9 +116,9 @@

## 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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L119

In general, use active voice instead of passive voice ('is found').

Check warning on line 119 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L119

Use 'can't' instead of 'cannot'.

### UI placement

Check warning on line 121 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L121

'UI placement' should use sentence-style capitalization.

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.

Expand Down Expand Up @@ -220,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.

Check warning on line 223 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L223

Try to avoid using first-person plural like 'we'.

1. Navigate to the [assistant page](https://dashboard.mintlify.com/products/assistant) in your dashboard.
1. Click **Chat history**.
Expand All @@ -238,11 +238,19 @@

### Categories

The categories tab uses LLMs to automatically categorize conversations. Categories show a summary of the topic or theme, when a question was last asked about the category, and how many questions have been asked about the category over time.

Check warning on line 241 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L241

In general, use active voice instead of passive voice ('been asked').

Use categories to identify common topics, patterns in user needs and behavior, and areas where documentation might need expansion or clarification.

Click a category to view specific conversations about the category. You can then click individual conversations to view the complete chat thread, including the user's question, the assistant's response, and any sources cited.
#### View related conversations

Click a category row to expand it and view related conversations grouped under that category. The expanded view displays:

- A list of conversations related to the category
- The first user message from each conversation
- The number of messages in each conversation thread

Click an individual conversation to open a side panel with the complete chat thread, including the user's question, the assistant's response, and any sources cited.

### Chat history

Expand All @@ -251,8 +259,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.

Check warning on line 262 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L262

Use 'isn't' instead of 'is not'.

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.

Check warning on line 264 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L264

In general, use active voice instead of passive voice ('is updated').

</Accordion>
2 changes: 0 additions & 2 deletions integrations/analytics/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@

## Analytics events

We send the following events to your analytics provider. All events use the `docs.` prefix.

Check warning on line 611 in integrations/analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/overview.mdx#L611

Try to avoid using first-person plural like 'We'.

| Event name | Description |
| :-------------------------------------- | :-------------------------------------------------------------------------------------------------------- |
Expand All @@ -617,7 +617,7 @@
| `docs.api_playground.request` | When a user calls an API in the API playground. |
| `docs.code_block.copy` | When a user copies code from a code block. |
| `docs.code_block.ask_ai` | When a user asks the assistant to explain a code block. |
| `docs.content.view` | When a user views a page. Only available for analytics providers that do not track page views by default. |

Check warning on line 620 in integrations/analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/overview.mdx#L620

Use 'don't' instead of 'do not'.
| `docs.feedback.thumbs_up` | When a user clicks the positive feedback button. |
| `docs.feedback.thumbs_down` | When a user clicks the negative feedback button. |
| `docs.navitem.cta_click` | When a user clicks a call to action. |
Expand All @@ -627,9 +627,7 @@
| `docs.footer.powered_by_mintlify_click` | When a user clicks the "Powered by Mintlify" link. |
| `docs.assistant.source_click` | When a user clicks a citation in a chat. |
| `docs.assistant.suggestion_click` | When a user clicks a suggestion in a chat. |
| `docs.assistant.thumbs_up` | When a user clicks the positive feedback button in a chat. |
| `docs.assistant.thumbs_down` | When a user clicks the negative feedback button in a chat. |
| `docs.assistant.completed` | When a chat session is completed. |

Check warning on line 630 in integrations/analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/overview.mdx#L630

In general, use active voice instead of passive voice ('is completed').
| `docs.assistant.enter` | When a user initiates a chat. |
| `docs.assistant.ask_ai_on_text_selection` | When a user selects text and clicks "Ask AI" to ask about the selection. |
| `docs.assistant.shared` | When a user shares a chat conversation. |
Expand Down