Skip to content
Merged
Changes from 6 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
18 changes: 13 additions & 5 deletions guides/assistant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,32 @@
---

<Info>
The AI assistant is available on [Pro, Growth, and Enterprise plans](https://mintlify.com/pricing?ref=assistant).
The AI assistant is automatically enabled on [Pro, Growth, and Enterprise plans](https://mintlify.com/pricing?ref=assistant).
</Info>

## About the assistant

The assistant answers questions about your documentation through natural language queries. When users ask a question, the assistant searches your content, cites relevant sources, and provides contextual answers sourced from your documentation.
The assistant answers questions about your documentation through natural language queries. It is embedded directly in your documentation site, providing users with immediate access to contextual help.

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

Check warning on line 15 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/assistant.mdx#L15

Did you really mean 'agentic'?

You can monitor user interactions and export query data from your dashboard to gain insights into user needs and identify content gaps.
* **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.

The assistant is automatically enabled for accounts on Pro, Growth, and Enterprise plans. See [Pricing](https://mintlify.com/pricing) for details.
You can monitor assistant usage through your dashboard to understand user behavior and documentation effectiveness. Query data and interaction patterns can help identify:

* Frequently asked questions that might need better coverage.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we haven't shipped analytics yet, so the only interaction patterns we have atm is just a raw list of conversations: this is changing soon though!!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha. I think this is worth including now since people can export the data and do their own analysis, which is still valuable. I'll push an edit to make it clear that this is achieved through your own analysis and not in the dashboard.

* Content gaps where users struggle to find answers.
* Popular topics that could benefit from additional content.

Export query data to analyze trends and prioritize documentation improvements based on real user needs.

## Using the assistant

Users can access the assistant in two ways:

- **Keyboard shortcut**: <kbd>Command</kbd> + <kbd>I</kbd> (<kbd>Ctrl</kbd> + <kbd>I</kbd> on Windows)

Check warning on line 33 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/assistant.mdx#L33

Did you really mean 'Ctrl'?
- **Assistant button** next to the search bar
<img
src="/images/assistant/assistant-button-light.png"
Expand All @@ -45,7 +53,7 @@

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.

## Making content AI ingestible

Check warning on line 56 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/assistant.mdx#L56

Did you really mean 'ingestible'?

Structure your documentation to help the assistant provide accurate, relevant answers. Clear organization and comprehensive context benefit both human readers and AI understanding.

Expand All @@ -54,7 +62,7 @@
- Write descriptive headings for sections.
- Create a logical information hierarchy.
- Use consistent formatting across your docs.
- Include comprehensive metadata in page frontmatter.

Check warning on line 65 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/assistant.mdx#L65

Did you really mean 'frontmatter'?
- Break up long blocks of text into shorter paragraphs.
</Card>

Expand Down
Loading