You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
alt="Search bar and assistant button in light mode."
34
+
/>
35
+
36
+
<img
37
+
src="/images/assistant/assistant-button-dark.png"
38
+
className="hidden dark:block"
39
+
alt="Search bar and assistant button in dark mode."
40
+
/>
32
41
</Frame>
33
42
43
+
Both options open the assistant in the right side panel.
44
+
45
+
Ask any questions and the assistant will search your docs for an answer. If the assistant cannot find an answer in your documentation, it will respond that it cannot answer the question.
46
+
34
47
## Making content AI ingestible
35
48
36
49
To help the assistant provide accurate answers, structure your documentation with both human readers and AI tools in mind. Well-organized, thorough content makes it easier for the assistant to understand your documentation and deliver relevant responses to users.
37
50
38
51
### Structure and organization
39
52
40
-
- Write descriptive headings that indicate what setions are about.
53
+
- Write descriptive headings for sections.
41
54
- Create a logical information hierarchy with proper nesting (H1 \> H2 \> H3).
42
55
- Break up long blocks of text into shorter paragraphs.
43
56
- Use consistent formatting across your docs.
@@ -51,12 +64,45 @@ To help the assistant provide accurate answers, structure your documentation wit
51
64
52
65
### AI optimization
53
66
54
-
- Add hidden pages with additional context that users don't need, but the assistant can reference.
67
+
- Add hidden pages with additional context that users don't need, but the assistant can reference.
55
68
- Use semantic markup.
56
-
- Include comprehensive metadata in pages' frontmatter.
69
+
- Include comprehensive metadata in page frontmatter.
57
70
58
71
## Exporting queries
59
72
60
-
How to and what to do with the information
73
+
You can review and export queries from your dashboard. Some ways that analyzing queries can help you improve your documentation:
74
+
75
+
- Identify content gaps for any queries that are frequent, but have insufficient responses or sources.
76
+
- Conduct lightweight user research by looking for themes and patterns in queries.
77
+
- See which pages are used as sources and prioritize them for accuracy and quality.
78
+
79
+
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.
80
+
81
+
1. Navigate to the [assistant page](https://dashboard.mintlify.com/products/assistant) in your dashboard.
82
+
2. Select **Export to CSV**.
83
+
3. Upload the queries into your AI tool and ask questions to learn about how your users are engaging with your docs. Some prompts to get you started:
84
+
85
+
- Summarize the most common themes of the queries.
86
+
- List any queries that had no sources cited.
87
+
88
+
## Changing the model
89
+
90
+
The assistant uses Claude Sonnet 4 by default. We have found that this model performs the best when searching and answering questions.
91
+
92
+
If you want to select another model:
93
+
94
+
1. Navigate to the [assistant page](https://dashboard.mintlify.com/products/assistant) in your dashboard.
0 commit comments