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: navigation.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ description: "Structure and customize your documentation's navigation hierarchy"
4
4
icon: "map"
5
5
---
6
6
7
-
The [navigation](settings#param-navigation) property in `docs.json`defines how your documentation is organized.
7
+
The [navigation](settings#param-navigation) property in `docs.json`controls the structure and information hierarchy of your documentation.
8
8
9
-
With proper navigation configuration, you can organize your content into a logical hierarchy that makes it easy for users to find exactly what they're looking for.
9
+
With proper navigation configuration, you can organize your content so that users can find exactly what they're looking for.
10
10
11
11
<Info>
12
12
Do not use `api` or `mcp` as titles for any navigation element. The `/api` and `/mcp` paths are reserved in production and will cause pages to return 404 errors if their URLs contain `/api` or `/mcp`.
@@ -238,9 +238,9 @@ In the `navigation` object, `anchors` is an array where each entry is an object
238
238
}
239
239
```
240
240
241
-
Use a `global` object for anchors to external links that exist outside your navigation hierarchy. Anchors in a `global` object are particularly useful for linking to resources that are not part of your documentation like a blog or support portal, but should be readily accessible to your users.
241
+
For anchors that direct to external links only, use the `global` keyword. Anchors in a `global` object must have an `href` field and cannot point to a relative path.
242
242
243
-
Anchors in a `global` object must have an `href` field and cannot direct to a relative path.
243
+
Global anchors are particularly useful for linking to resources that are not part of your documentation, but should be readily accessible to your users like a blog or support portal
0 commit comments