Skip to content
Open
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
168 changes: 168 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

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

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

### Tags and labels

Use tags to highlight important navigation items and draw attention to new, updated, or deprecated content. Tags appear as small labels next to navigation group names in the sidebar.

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

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

#### Adding tags to navigation groups

Add the `tag` field to any navigation group to display a label. Tags work with all navigation elements that support groups, including tabs, anchors, dropdowns, and products.

```json
{
"navigation": {
"groups": [
{
"group": "Getting started",
"icon": "play",
"tag": "NEW",
"pages": ["quickstart", "installation"]
},
{
"group": "API v2",
"icon": "code",
"tag": "BETA",
"pages": ["api/v2/overview", "api/v2/endpoints"]
},
{
"group": "Legacy API",
"icon": "archive",
"tag": "DEPRECATED",
"pages": ["api/v1/overview"]
}
]
}
}
```

#### Tag best practices

Use tags strategically to guide users to the most relevant content:

- **NEW**: Highlight recently added features or documentation sections

Check warning on line 173 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L173

Spell out 'NEW', if it's unfamiliar to the audience.
- **BETA**: Indicate features in testing or early access

Check warning on line 174 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L174

Spell out 'BETA', if it's unfamiliar to the audience.
- **UPDATED**: Draw attention to recently revised content
- **DEPRECATED**: Mark outdated features that will be removed

Check warning on line 176 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L176

Avoid using 'will'.

Check warning on line 176 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L176

In general, use active voice instead of passive voice ('be removed').
- **PREVIEW**: Show experimental features available for early feedback
- **PRO** or **ENTERPRISE**: Denote premium or tier-specific features

Check warning on line 178 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L178

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

Keep tag text short and descriptive. Tags longer than 12 characters may be truncated on smaller screens.

Check warning on line 180 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L180

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

#### Tags in different navigation contexts

Tags work consistently across all navigation elements:

<CodeGroup>

```json Groups with tags
{
"navigation": {
"groups": [
{
"group": "Core features",
"tag": "STABLE",
"pages": ["features/auth", "features/storage"]
},
{
"group": "Experimental",
"tag": "PREVIEW",
"pages": ["features/ai", "features/realtime"]
}
]
}
}
```

```json Tabs with tagged groups
{
"navigation": {
"tabs": [
{
"tab": "Documentation",
"icon": "book-open",
"groups": [
{
"group": "Getting started",
"tag": "NEW",
"pages": ["quickstart"]
},
{
"group": "Advanced guides",
"pages": ["deployment", "scaling"]
}
]
}
]
}
}
```

```json Anchors with tagged groups
{
"navigation": {
"anchors": [
{
"anchor": "API Reference",
"icon": "code",
"groups": [
{
"group": "REST API v3",
"tag": "LATEST",
"pages": ["api/v3/users", "api/v3/projects"]
},
{
"group": "REST API v2",
"tag": "DEPRECATED",
"pages": ["api/v2/users", "api/v2/projects"]
}
]
}
]
}
}
```

```json Nested groups with tags
{
"navigation": {
"groups": [
{
"group": "Platform",
"pages": [
{
"group": "Authentication",
"tag": "UPDATED",
"pages": ["auth/oauth", "auth/jwt"]
},
{
"group": "Webhooks",
"tag": "BETA",
"pages": ["webhooks/setup", "webhooks/events"]
}
]
}
]
}
}
```

</CodeGroup>

#### Styling considerations

Tags inherit your documentation's primary color scheme by default. The appearance adapts automatically to light and dark modes based on your theme configuration.

<Note>
Tags are purely visual indicators and do not affect navigation functionality or page accessibility. Users can still access all pages within tagged groups normally.

Check warning on line 287 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L287

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 @@ -293,7 +461,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 464 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L464

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

<img
className="block dark:hidden pointer-events-none"
Expand Down Expand Up @@ -408,7 +576,7 @@

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 579 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L579

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.
Expand Down Expand Up @@ -578,7 +746,7 @@

## 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 749 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L749

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.

Expand Down Expand Up @@ -802,7 +970,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 973 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L973

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

<CodeGroup>

Expand All @@ -826,10 +994,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 997 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L997

Avoid using 'will'.

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

Check warning on line 999 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L999

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 1000 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L1000

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

<CodeGroup>
Expand Down
Loading