Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
209 changes: 209 additions & 0 deletions organize/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,11 @@

Use the `expanded` property to control the default state of a nested group in the navigation sidebar.

- `expanded: true`: Group is expanded by default.

Check warning on line 101 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L101

In general, use active voice instead of passive voice ('is expanded').
- `expanded: false` or omitted: Group is collapsed by default.

Check warning on line 102 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L102

In general, use active voice instead of passive voice ('is collapsed').

<Note>
The `expanded` property only affects nested groups--groups within groups. Top-level groups are always expanded and cannot be collapsed.

Check warning on line 105 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L105

Use 'can't' instead of 'cannot'.

Check warning on line 105 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L105

In general, use active voice instead of passive voice ('be collapsed').
</Note>

```json
Expand All @@ -119,6 +119,215 @@
}
```

### Tags and labels

Use tags to highlight navigation groups with status indicators or labels. Tags appear as small badges next to group names in the sidebar, helping users identify new features, beta functionality, or deprecated content.

Check warning on line 124 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L124

Use 'capability' or 'feature' instead of 'functionality'.

<img
className="block dark:hidden pointer-events-none"
src="/images/navigation/tags-light.png"
alt="Navigation groups with tags displayed in light mode."
/>

<img
className="hidden dark:block pointer-events-none"
src="/images/navigation/tags-dark.png"
alt="Navigation groups with tags displayed in dark mode."
/>

Add the `tag` field to any navigation group to display a label. Tags are most effective when used sparingly to draw attention to important changes or status.

```json
{
"navigation": {
"groups": [
{
"group": "AI features",
"icon": "sparkles",
"tag": "NEW",
"pages": ["ai/chat", "ai/search"]
},
{
"group": "Experimental APIs",
"icon": "flask",
"tag": "BETA",
"pages": ["api/experimental/webhooks"]
}
]
}
}
```

#### Common tag patterns

Use consistent tag labels across your documentation to create clear expectations for users.

<CodeGroup>

```json New features
{
"group": "Real-time collaboration",
"icon": "users",
"tag": "NEW",
"pages": ["collaboration/overview", "collaboration/setup"]
}
```

```json Beta features
{
"group": "Advanced analytics",
"icon": "chart-line",
"tag": "BETA",
"pages": ["analytics/custom-reports", "analytics/data-export"]
}
```

```json Deprecated features
{
"group": "Legacy API",
"icon": "triangle-exclamation",
"tag": "DEPRECATED",
"pages": ["legacy/v1-endpoints", "legacy/migration-guide"]
}
```

```json Preview features
{
"group": "Upcoming features",
"icon": "eye",
"tag": "PREVIEW",
"pages": ["preview/feature-a", "preview/feature-b"]
}
```

```json Updated content
{
"group": "Security",
"icon": "shield",
"tag": "UPDATED",
"pages": ["security/authentication", "security/authorization"]
}
```

</CodeGroup>

#### Tags with navigation elements

Tags work with groups at any level of your navigation hierarchy. You can add tags to top-level groups, nested groups, and groups within tabs, anchors, or other navigation containers.

<CodeGroup>

```json Tags in tabs
{
"navigation": {
"tabs": [
{
"tab": "Documentation",
"groups": [
{
"group": "Getting started",
"pages": ["quickstart"]
},
{
"group": "New features",
"tag": "NEW",
"pages": ["features/ai-assistant", "features/real-time-sync"]
}
]
}
]
}
}
```

```json Tags in anchors
{
"navigation": {
"anchors": [
{
"anchor": "Documentation",
"icon": "book-open",
"groups": [
{
"group": "Core concepts",
"pages": ["concepts/overview"]
},
{
"group": "Advanced topics",
"tag": "BETA",
"pages": ["advanced/webhooks", "advanced/custom-integrations"]
}
]
}
]
}
}
```

```json Tags in nested groups
{
"navigation": {
"groups": [
{
"group": "API reference",
"pages": [
{
"group": "Core endpoints",
"pages": ["api/users", "api/projects"]
},
{
"group": "Experimental endpoints",
"tag": "BETA",
"pages": ["api/experimental/ai", "api/experimental/webhooks"]
}
]
}
]
}
}
```

```json Multiple tagged groups
{
"navigation": {
"groups": [
{
"group": "Platform features",
"tag": "NEW",
"pages": ["platform/overview"]
},
{
"group": "Mobile SDK",
"tag": "BETA",
"pages": ["mobile/ios", "mobile/android"]
},
{
"group": "Legacy features",
"tag": "DEPRECATED",
"pages": ["legacy/old-api"]
}
]
}
}
```

</CodeGroup>

#### Best practices for tags

Follow these guidelines to use tags effectively in your documentation:

- **Use sparingly**: Too many tags reduce their impact. Reserve tags for genuinely important status indicators.
- **Be consistent**: Use the same tag labels across your documentation. Avoid mixing "NEW" and "Latest" or "BETA" and "Experimental."

Check warning on line 321 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L321

Spell out 'NEW', if it's unfamiliar to the audience.

Check warning on line 321 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L321

Spell out 'BETA', if it's unfamiliar to the audience.
- **Keep labels short**: Tags work best with 3-10 characters. Long labels may be truncated or wrap awkwardly.

Check warning on line 322 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L322

In general, use active voice instead of passive voice ('be truncated').
- **Update regularly**: Remove "NEW" tags after features are established. Update "BETA" to stable or remove the tag when features graduate.

Check warning on line 323 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L323

Spell out 'NEW', if it's unfamiliar to the audience.

Check warning on line 323 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L323

In general, use active voice instead of passive voice ('are established').

Check warning on line 323 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L323

Spell out 'BETA', if it's unfamiliar to the audience.
- **Combine with icons**: Pair tags with relevant icons to reinforce meaning. For example, use a warning icon with "DEPRECATED" tags.
- **Consider color**: Tags inherit your theme colors. Ensure your primary color works well for all tag types.

<Note>
Tags are purely visual indicators in the navigation. They do not affect page functionality, search indexing, or content visibility.

Check warning on line 328 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L328

Use 'don't' instead of 'do not'.

Check warning on line 328 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L328

Use 'capability' or 'feature' instead of 'functionality'.
</Note>

## Tabs

Tabs create distinct sections of your documentation with separate URL paths. Tabs create a horizontal navigation bar at the top of your documentation that lets users switch between sections.
Expand Down Expand Up @@ -271,7 +480,7 @@
Use global anchors for external links that should appear on all pages, regardless of which section of your navigation the user is viewing. Global anchors are particularly useful for linking to resources outside your documentation, such as a blog, community forum, or support portal.

<Note>
Global anchors must include an `href` field pointing to an external URL. They cannot contain relative paths.

Check warning on line 483 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L483

Use 'can't' instead of 'cannot'.
</Note>

```json
Expand All @@ -298,7 +507,7 @@

## Dropdowns

Dropdowns are contained in an expandable menu at the top of your sidebar navigation. Each item in a dropdown directs to a section of your documentation.

Check warning on line 510 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L510

In general, use active voice instead of passive voice ('are contained').

<img
className="block dark:hidden pointer-events-none"
Expand Down Expand Up @@ -413,10 +622,10 @@

Integrate OpenAPI specifications directly into your navigation structure to automatically generate API documentation. Create dedicated API sections or place endpoint pages within other navigation components.

Set a default OpenAPI specification at any level of your navigation hierarchy. Child elements will inherit this specification unless they define their own specification.

Check warning on line 625 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L625

Avoid using 'will'.

<Note>
When you add the `openapi` property to a navigation element (such as an anchor, tab, or group) without specifying any pages, Mintlify automatically generates pages for **all endpoints** defined in your OpenAPI specification.

Check warning on line 628 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L628

Use parentheses judiciously.

To control which endpoints appear, explicitly list the desired endpoints in a `pages` array.
</Note>
Expand Down Expand Up @@ -513,7 +722,7 @@

In the `navigation` object, `languages` is an array where each entry is an object that requires a `language` field and can contain any other navigation fields.

We currently support the following languages for localization:

Check warning on line 725 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L725

Try to avoid using first-person plural like 'We'.

<CardGroup cols={2}>
<Card title="Arabic (ar)" icon="/images/navigation/languages/ar.png" horizontal />
Expand Down Expand Up @@ -575,9 +784,9 @@

## Nesting

Navigation elements can be nested within each other to create complex hierarchies. You must have one root-level parent navigation element such as tabs, groups, or a dropdown. You can nest other types of navigation elements within your primary navigation pattern.

Check warning on line 787 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L787

In general, use active voice instead of passive voice ('be nested').

Each navigation element can contain one type of child element at each level of your navigation hierarchy. For example, a tab can contain anchors that contain groups, but a tab cannot contain both anchors and groups at the same level.

Check warning on line 789 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L789

Use 'can't' instead of 'cannot'.

<CodeGroup>

Expand Down Expand Up @@ -799,7 +1008,7 @@

## Breadcrumbs

Breadcrumbs display the full navigation path at the top of pages. Some themes have breadcrumbs enabled by default and others do not. You can control whether breadcrumbs are enabled for your site using the `styling` property in your `docs.json`.

Check warning on line 1011 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L1011

Use 'don't' instead of 'do not'.

Check warning on line 1011 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L1011

In general, use active voice instead of passive voice ('are enabled').

<CodeGroup>

Expand All @@ -823,10 +1032,10 @@

### Enable auto-navigation for groups

When a user expands a navigation group, some themes will automatically navigate to the first page in the group. You can override a theme's default behavior using the `drilldown` option.

Check warning on line 1035 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L1035

Avoid using 'will'.

- Set to `true` to force automatic navigation to the first page when a navigation group is selected.

Check warning on line 1037 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L1037

In general, use active voice instead of passive voice ('is selected').
- Set to `false` to prevent navigation and only expand or collapse the group when it is selected.

Check warning on line 1038 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L1038

Use 'it's' instead of 'it is'.

Check warning on line 1038 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L1038

In general, use active voice instead of passive voice ('is selected').
- Leave unset to use the theme's default behavior.

<CodeGroup>
Expand Down
Loading