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
@@ -23,7 +26,15 @@ The assistant is automatically enabled for accounts on Pro, Growth, and Enterpri
23
26
24
27
There are two ways to access the assistant in your documentation:
25
28
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).
27
38
-**Select the assistant button** next to the search bar.
28
39
29
40
<Frame>
@@ -54,19 +65,16 @@ To help the assistant provide accurate answers, structure your documentation wit
54
65
- Create a logical information hierarchy with proper nesting (H1 \> H2 \> H3).
55
66
- Break up long blocks of text into shorter paragraphs.
56
67
- Use consistent formatting across your docs.
68
+
- Use semantic markup.
69
+
- Include comprehensive metadata in page frontmatter.
57
70
58
71
### Context
59
72
60
73
- Define specific terms and acronyms when first introduced.
61
74
- Provide sufficient conceptual content about features and procedures.
62
75
- Include examples and use cases.
63
76
- 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.
Copy file name to clipboardExpand all lines: guides/hidden-pages.mdx
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,11 +16,13 @@ If you want to hide pages for specific groups of users, use personalization to c
16
16
17
17
A page is hidden if it is not included in your `docs.json` navigation. To hide a page, remove it from your navigation structure.
18
18
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
+
19
21
<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.
21
23
</Note>
22
24
23
-
## Search, SEO, and AI context
25
+
## Search, SEO, and AI indexing
24
26
25
27
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`:
26
28
@@ -30,4 +32,4 @@ By default, hidden pages are excluded from indexing for search engines, internal
30
32
}
31
33
```
32
34
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