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
Copy file name to clipboardExpand all lines: guides/assistant.mdx
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ Both methods open a chat panel on the right side of your docs. Users can ask any
49
49
50
50
Structure your documentation to help the assistant provide accurate, relevant answers. Clear organization and comprehensive context benefit both human readers and AI understanding.
51
51
52
-
<Cardtitle="Structure and organization"icon="layers">
52
+
<Cardtitle="Structure and organization">
53
53
- Use semantic markup.
54
54
- Write descriptive headings for sections.
55
55
- Create a logical information hierarchy.
@@ -58,15 +58,14 @@ Structure your documentation to help the assistant provide accurate, relevant an
58
58
- Break up long blocks of text into shorter paragraphs.
59
59
</Card>
60
60
61
-
<Cardtitle="Context"icon="book-open">
61
+
<Cardtitle="Context">
62
62
- Define specific terms and acronyms when first introduced.
63
63
- Provide sufficient conceptual content about features and procedures.
64
64
- Include examples and use cases.
65
65
- Cross-reference related topics.
66
66
- Add [hidden pages](/guides/hidden-pages) with additional context that users don't need, but the assistant can reference.
67
67
</Card>
68
68
69
-
70
69
## Exporting and analyzing queries
71
70
72
71
Review and export queries from your dashboard to understand how people interact with your documentation and identify improvement opportunities. Some ways that analyzing queries can help you improve your documentation:
@@ -81,7 +80,7 @@ You can explore queries from your [dashboard](https://dashboard.mintlify.com/pro
81
80
2. Select **Export to CSV**.
82
81
3. Analyze the exported data using your preferred tool.
0 commit comments