Skip to content

Commit fbc2ffd

Browse files
authored
Documentation edits made through Mintlify web editor
1 parent 42d12dd commit fbc2ffd

File tree

2 files changed

+23
-13
lines changed

2 files changed

+23
-13
lines changed

guides/assistant.mdx

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@ icon: "bot"
55
---
66

77
<Info>
8-
The AI assistant is available on [Pro, Growth, and Enterprise plans](https://mintlify.com/pricing?ref=assistant). Please{" "}
9-
<a href="mailto:[email protected]">contact sales</a> for more information.
8+
The AI assistant is available on [Pro, Growth, and Enterprise plans](https://mintlify.com/pricing?ref=assistant). Please" "
9+
<a href="mailto:[email protected]">
10+
contact sales</a>
11+
12+
for more information.
1013
</Info>
1114

1215
## About the assistant
@@ -23,7 +26,15 @@ The assistant is automatically enabled for accounts on Pro, Growth, and Enterpri
2326

2427
There are two ways to access the assistant in your documentation:
2528

26-
- **Use the keyboard shortcut** <kbd>Command</kbd> + <kbd>I</kbd> (<kbd>Ctrl</kbd> + <kbd>I</kbd> on Windows).
29+
- **Use the keyboard shortcut** <kbd>Command</kbd>
30+
31+
\+ <kbd>I</kbd>
32+
33+
(<kbd>Ctrl</kbd>
34+
35+
\+ <kbd>I</kbd>
36+
37+
on Windows).
2738
- **Select the assistant button** next to the search bar.
2839

2940
<Frame>
@@ -54,19 +65,16 @@ To help the assistant provide accurate answers, structure your documentation wit
5465
- Create a logical information hierarchy with proper nesting (H1 \> H2 \> H3).
5566
- Break up long blocks of text into shorter paragraphs.
5667
- Use consistent formatting across your docs.
68+
- Use semantic markup.
69+
- Include comprehensive metadata in page frontmatter.
5770

5871
### Context
5972

6073
- Define specific terms and acronyms when first introduced.
6174
- Provide sufficient conceptual content about features and procedures.
6275
- Include examples and use cases.
6376
- Cross-reference related topics.
64-
65-
### AI optimization
66-
67-
- Add hidden pages with additional context that users don't need, but the assistant can reference. See [Hidden pages](/guides/hidden-pages#ai-context) for more information.
68-
- Use semantic markup.
69-
- Include comprehensive metadata in page frontmatter.
77+
- Add [hidden pages](/guides/hidden-pages) with additional context that users don't need, but the assistant can reference.
7078

7179
## Exporting queries
7280

@@ -105,4 +113,4 @@ Available models:
105113
- o3-mini
106114
- Gemini 2.5 Pro (Preview)
107115
- Llama 4 Maverick
108-
- Grok 3
116+
- Grok 3

guides/hidden-pages.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,13 @@ If you want to hide pages for specific groups of users, use personalization to c
1616

1717
A page is hidden if it is not included in your `docs.json` navigation. To hide a page, remove it from your navigation structure.
1818

19+
Hidden pages use the same URL structure as regular pages based on their file path. For example, `guides/hidden-page.mdx` would be accessible at `docs.yoursite.com/guides/hidden-page`.
20+
1921
<Note>
20-
Some navigation elements like sidebars, dropdowns, and tabs may appear empty or shift layout on hidden pages.
22+
Some navigation elements like sidebars, dropdowns, and tabs may appear empty or shift layout on hidden pages.
2123
</Note>
2224

23-
## Search, SEO, and AI context
25+
## Search, SEO, and AI indexing
2426

2527
By default, hidden pages are excluded from indexing for search engines, internal search within your docs, and as context for the AI assistant. To include hidden pages in search results and as context for the assistant, add the `seo` property to your `docs.json`:
2628

@@ -30,4 +32,4 @@ By default, hidden pages are excluded from indexing for search engines, internal
3032
}
3133
```
3234

33-
To exclude a specific page, add `noindex: "true"` to its frontmatter.
35+
To exclude a specific page, add `noindex: "true"` to its frontmatter.

0 commit comments

Comments
 (0)