Skip to content
Closed
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
14 changes: 14 additions & 0 deletions guides/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, providing users with immediate access to contextual help.

Check warning on line 13 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L13

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

Check warning on line 13 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/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. When users ask questions, the assistant:

Check warning on line 15 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L15

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

Check warning on line 15 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/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 guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/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,8 +28,22 @@

## Configuring the assistant

The assistant is enabled by default for Pro and Custom plans. You can manage the assistant from your [dashboard](https://dashboard.mintlify.com/products/assistant/settings), including enabling or disabling it, configuring response handling, and setting a spend limit.

Check warning on line 31 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L31

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

### Assistant entry point

You can configure how users access the assistant by adding the `enableAskAiButton` configuration to your `docs.json` file:

```json
{
"assistant": {
"enableAskAiButton": true
}
}
```

When `enableAskAiButton` is set to `true`, the assistant appears as an "Ask AI" button in the topbar next to the search bar. When set to `false` or omitted, the assistant displays as a floating button that appears after a delay.

### Assistant status

Toggle the assistant status to enable or disable the assistant for your documentation site.
Expand Down Expand Up @@ -92,9 +106,9 @@
}}
alt="Search bar and assistant button in dark mode."
/>
- **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).

Check warning on line 109 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L109

Avoid using 'will'.

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.

Check warning on line 111 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L111

Avoid using 'will'.

Check warning on line 111 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L111

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

Check warning on line 111 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L111

Avoid using 'will'.

Check warning on line 111 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L111

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

## Making content AI ingestible

Expand Down Expand Up @@ -125,7 +139,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 142 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L142

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

1. Navigate to the [assistant page](https://dashboard.mintlify.com/products/assistant) in your dashboard.
2. Select **Export to CSV**.
Expand Down
12 changes: 12 additions & 0 deletions settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
```json
{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",

Check warning on line 23 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L23

Commas and periods go inside quotation marks.
"name": "Your Docs",

Check warning on line 24 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L24

Commas and periods go inside quotation marks.
"colors": {
"primary": "#ff0000"
},
Expand Down Expand Up @@ -723,6 +723,18 @@
</Expandable>
</ResponseField>

### Assistant

<ResponseField name="assistant" type="object">
AI assistant configuration settings.

<Expandable title="Assistant">
<ResponseField name="enableAskAiButton" type="boolean">
Controls how users access the AI assistant. When set to `true`, displays an "Ask AI" button in the topbar next to the search bar. When set to `false` or omitted, shows a floating assistant button that appears after a delay. Defaults to `false`.
</ResponseField>
</Expandable>
</ResponseField>

### Integrations

<ResponseField name="integrations" type="object">
Expand Down Expand Up @@ -1493,7 +1505,7 @@

</CodeGroup>

If you already have the CLI installed, make sure it is up to date:

Check warning on line 1508 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1508

Use 'command-line tool' instead of 'CLI'.

Check warning on line 1508 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1508

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

```bash
mint update
Expand All @@ -1507,7 +1519,7 @@
mint upgrade
```

This command will create a `docs.json` file from your existing `mint.json`. Review the generated file to ensure all settings are correct.

Check warning on line 1522 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1522

Avoid using 'will'.
</Step>
<Step title="Delete your mint.json file">
After verifying your `docs.json` is configured properly, you can safely delete your old `mint.json` file.
Expand Down