Skip to content

Commit d4b0aff

Browse files
authored
Documentation edits made through Mintlify web editor
1 parent becca77 commit d4b0aff

File tree

1 file changed

+53
-7
lines changed

1 file changed

+53
-7
lines changed

guides/assistant.mdx

Lines changed: 53 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,30 @@ There are two ways to access the assistant in your documentation:
2727
- **Select the assistant button** next to the search bar.
2828

2929
<Frame>
30-
<img src="/images/assistant/assistant-button-light.png" className="block dark:hidden" alt="Search bar and assistant button in light mode."/>
31-
<img src="/images/assistant/assistant-button-dark.png" className="block light:hidden" alt="Search bar and assistant button in dark mode."/>
30+
<img
31+
src="/images/assistant/assistant-button-light.png"
32+
className="block dark:hidden"
33+
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+
/>
3241
</Frame>
3342

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+
3447
## Making content AI ingestible
3548

3649
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.
3750

3851
### Structure and organization
3952

40-
- Write descriptive headings that indicate what setions are about.
53+
- Write descriptive headings for sections.
4154
- Create a logical information hierarchy with proper nesting (H1 \> H2 \> H3).
4255
- Break up long blocks of text into shorter paragraphs.
4356
- Use consistent formatting across your docs.
@@ -51,12 +64,45 @@ To help the assistant provide accurate answers, structure your documentation wit
5164

5265
### AI optimization
5366

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.
5568
- Use semantic markup.
56-
- Include comprehensive metadata in pages' frontmatter.
69+
- Include comprehensive metadata in page frontmatter.
5770

5871
## Exporting queries
5972

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.
95+
2. Select **Manage**.
96+
3. Choose your preferred model.
97+
4. Select **Save**.
98+
99+
Available models:
61100

62-
## Changing the model
101+
- Claude 4 Sonnet (default)
102+
- Claude 3.7 Sonnet
103+
- GPT 4.1
104+
- GPT-4o
105+
- o3-mini
106+
- Gemini 2.5 Pro (Preview)
107+
- Llama 4 Maverick
108+
- Grok 3

0 commit comments

Comments
 (0)