Skip to content

Add assistant URL option #1074

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 4, 2025
Merged

Add assistant URL option #1074

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c8fa12
add assistant URL method
ethanpalm Sep 4, 2025
74c1d51
💅
ethanpalm Sep 4, 2025
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
5 changes: 3 additions & 2 deletions guides/assistant.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

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

Did you really mean 'agentic'?

* **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.
Expand Down Expand Up @@ -44,9 +44,9 @@

## Using the assistant

Users can access the assistant in two ways:
Users can access the assistant in three ways:

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

Check warning on line 49 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L49 

Did you really mean 'Ctrl'?
- **Assistant button** next to the search bar
<img
src="/images/assistant/assistant-button-light.png"
Expand All @@ -66,10 +66,11 @@
}}
alt="Search bar and assistant button in dark mode."
/>
- **URLs** with `?aiassistant=open` appended will open the assistant when the page loads. For example, [https://mintlify.com/docs?aiassistant=open](https://mintlify.com/docs?aiassistant=open).

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L73 

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 @@ -78,7 +79,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 82 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L82 

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

Expand Down