-
Notifications
You must be signed in to change notification settings - Fork 207
Document site search #1137
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.
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
Document site search #1137
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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: | ||
|
|
||
| * **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. | ||
|
|
@@ -30,19 +30,34 @@ | |
|
|
||
| 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. | ||
|
|
||
| ### Enable or disable the assistant | ||
| ### Assistant status | ||
|
|
||
| Toggle the assistant status to enable or disable the assistant for your documentation site. | ||
|
|
||
| ### Response handling | ||
| ### Assistant deflection | ||
|
|
||
| Configure how the assistant responds when it cannot find answers in your documentation. You can redirect unanswered questions to your support team and enable the assistant to search external websites. | ||
| Enable the assistant to redirect unanswered questions to your support team. Provide an email address that the assistant will provide to users who ask questions that it cannot answer. | ||
|
|
||
| - **Assistant Deflection**: When enabled, the assistant directs users to your support team for questions that it cannot answer. | ||
| - **Search Sites**: The assistant can search specified external sites for additional context when answering questions. | ||
| <Note> | ||
| Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:[email protected]). | ||
| </Note> | ||
| ### Search sites | ||
|
|
||
| <Note> | ||
| Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:[email protected]). | ||
| </Note> | ||
|
|
||
| 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. | ||
|
|
||
| You can use Exa's [filtering syntax](https://docs.exa.ai/changelog/domain-path-filter) when you configure external sites. | ||
|
|
||
| - **Domain-level filtering** | ||
| - `example.com`: Search the entire domain | ||
ethanpalm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - `docs.example.com`: Search only the docs subdomain | ||
| - **Path-level filtering** | ||
| - `docs.example.com/api/*`: Only search API documentation sections | ||
ethanpalm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - **Multiple patterns** | ||
| - You can add multiple entries to target different sections across sites for more granular control over what external content the assistant can reference. | ||
|
|
||
| ### Spend limit | ||
|
|
||
|
|
@@ -56,7 +71,7 @@ | |
|
|
||
| Users can access the assistant in three ways: | ||
|
|
||
| - **Keyboard shortcuts**: <kbd>?</kbd> or <kbd>Command</kbd> + <kbd>I</kbd> (<kbd>Ctrl</kbd> + <kbd>I</kbd> on Windows) | ||
| - **Assistant button** next to the search bar | ||
| <img | ||
| src="/images/assistant/assistant-button-light.png" | ||
|
|
@@ -80,7 +95,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 | ||
|
|
||
| Structure your documentation to help the assistant provide accurate, relevant answers. Clear organization and comprehensive context benefit both human readers and AI understanding. | ||
|
|
||
|
|
@@ -89,7 +104,7 @@ | |
| - Write descriptive headings for sections. | ||
| - Create a logical information hierarchy. | ||
| - Use consistent formatting across your docs. | ||
| - Include comprehensive metadata in page frontmatter. | ||
| - Break up long blocks of text into shorter paragraphs. | ||
| </Card> | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.