Skip to main content
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 the assistant cannot retrieve relevant information, the assistant responds that it cannot answer the question.

​
Use the assistant in local preview

The assistant is available in your local preview when you log in with the CLI. This lets you test assistant behavior, custom instructions in Assistant.md, and responses while developing documentation locally.
  1. If you haven’t already, install the CLI with npm i -g mint.
  2. Run mint login to authenticate.
  3. Run mint dev to start the local preview.
The assistant in local preview uses the same indexed content as your deployed documentation site.

​
UI placement

The assistant appears in two locations: as a button next to the search bar and as a bar at the bottom of the page.
Search bar and assistant button in light mode.
Assistant bar in light mode.

​
Keyboard shortcut

Open the assistant chat panel with the keyboard shortcut Command + I on macOS and Ctrl + I 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.
The Add to assistant button above highlighted text in light mode.

​
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.
The Ask AI button in a code block in light mode.

​
File attachments

Attach files to assistant messages to provide additional context. Supported file types:
  • Images: JPEG, PNG, GIF, WebP, SVG
  • Documents: PDF
  • Code and text files: JavaScript (.js, .jsx, .mjs, .cjs), TypeScript (.ts, .tsx), Python, HTML, CSS, Markdown, MDX, JSON, YAML, XML, SQL, CSV, plain text, shell scripts (.sh, .bash, .env), GraphQL, TOML, Go, Rust, Ruby, Java, Kotlin, Swift, C (.c, .h), C++ (.cpp, .hpp), C#, PHP, Lua, R, Scala
Limits:
  • Maximum file size: 5 MB per attachment
  • Maximum attachments per message: 10
An image added as context in the assistant chat panel.

​
URLs

Open the assistant with a URL query parameter to create deep links that guide users to specific information or share assistant conversations with pre-filled questions.

​
Troubleshooting

If the assistant UI is not visible in specific browsers, you may need to submit a false positive report to EasyList. 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 to request removal of the rule. This resolves the issue for all users once the filter list updates.

Related topics

AssistantConfigure the assistantCreate assistant message