Skip to content

Commit b8d7fd9

Browse files
committed
copyedits
1 parent f70bb58 commit b8d7fd9

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

navigation.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ description: "Structure and customize your documentation's navigation hierarchy"
44
icon: "map"
55
---
66

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.
88

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.
1010

1111
<Info>
1212
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
238238
}
239239
```
240240

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.
242242

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
244244

245245
```json
246246
{

0 commit comments

Comments
 (0)