Skip to content

Commit 45f0cf6

Browse files
authored
Documentation edits made through Mintlify web editor
1 parent 08771d9 commit 45f0cf6

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

guides/assistant.mdx

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,27 @@ The assistant is automatically enabled for accounts on Pro, Growth, and Enterpri
2424

2525
## Making content AI ingestible
2626

27-
Best practices
27+
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.
28+
29+
### Structure and organization
30+
31+
- Write descriptive headings that indicate what setions are about.
32+
- Create a logical information hierarchy with proper nesting (H1 \> H2 \> H3).
33+
- Break up long blocks of text into shorter paragraphs.
34+
- Use consistent formatting across your docs.
35+
36+
### Context
37+
38+
- Define specific terms and acronyms when first introduced.
39+
- Provide sufficient conceptual content about features and procedures.
40+
- Include examples and use cases.
41+
- Cross-reference related topics.
42+
43+
### AI optimization
44+
45+
- Add hidden pages with additional context that users don't need, but the assistant can reference.
46+
- Use semantic markup.
47+
- Include comprehensive metadata in pages' frontmatter.
2848

2949
## Exporting queries
3050

0 commit comments

Comments
 (0)