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
206 changes: 206 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,212 @@
}
```

### 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"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like these screenshots aren’t included in this PR—can you add /images/navigation/tags-light.png and /images/navigation/tags-dark.png (or update the paths) so the page doesn’t render broken images?

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 groups

Add a `tag` field to any group object in your navigation configuration. The tag value is a string that appears next to the group name.

```json
{
"navigation": {
"groups": [
{
"group": "API v2",
"tag": "NEW",
"icon": "rocket",
"pages": ["api-v2/overview", "api-v2/authentication"]
},
{
"group": "Experimental features",
"tag": "BETA",
"icon": "flask",
"pages": ["experimental/feature-a", "experimental/feature-b"]
},
{
"group": "Legacy API",
"tag": "DEPRECATED",
"icon": "triangle-exclamation",
"pages": ["legacy/overview", "legacy/endpoints"]
}
]
}
}
```

#### Tag best practices

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

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

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 that are in beta or preview status

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.
- **DEPRECATED**: Mark content that will be removed or replaced in future versions

Check warning on line 175 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L175

Avoid using 'will'.

Check warning on line 175 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L175

In general, use active voice instead of passive voice ('be removed').
- **UPDATED**: Draw attention to recently refreshed documentation
- **PREVIEW**: Identify early-access features or experimental functionality

Check warning on line 177 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L177

'early-access' doesn't need a hyphen.

Check warning on line 177 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L177

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

Keep tag text short and clear. Tags with more than 12 characters may be truncated in the sidebar.

Check warning on line 179 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L179

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure the 12-character truncation limit is stable across themes; keeping this generic might age better.

Suggested change
Keep tag text short and clear. Tags with more than 12 characters may be truncated in the sidebar.
Keep tag text short and clear. Longer tags may be truncated in the sidebar.


#### Tags with nested groups

Tags work with nested groups, allowing you to label both parent and child sections:

```json
{
"navigation": {
"groups": [
{
"group": "Platform API",
"tag": "v2.0",
"icon": "code",
"pages": [
"platform/overview",
{
"group": "Webhooks",
"tag": "NEW",
"icon": "webhook",
"pages": ["platform/webhooks/setup", "platform/webhooks/events"]
},
{
"group": "GraphQL",
"tag": "BETA",
"icon": "diagram-project",
"pages": ["platform/graphql/queries", "platform/graphql/mutations"]
}
]
}
]
}
}
```

#### Tags in different navigation contexts

Tags can be applied to groups within tabs, anchors, dropdowns, and other navigation elements:

Check warning on line 216 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L216

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

<CodeGroup>

```json Tags in tabs
{
"navigation": {
"tabs": [
{
"tab": "Documentation",
"icon": "book-open",
"groups": [
{
"group": "Getting started",
"pages": ["quickstart", "installation"]
},
{
"group": "Advanced features",
"tag": "NEW",
"icon": "sparkles",
"pages": ["advanced/caching", "advanced/webhooks"]
}
]
}
]
}
}
```

```json Tags in anchors
{
"navigation": {
"anchors": [
{
"anchor": "Documentation",
"icon": "book-open",
"groups": [
{
"group": "Core concepts",
"pages": ["concepts/overview", "concepts/architecture"]
},
{
"group": "AI features",
"tag": "BETA",
"icon": "brain",
"pages": ["ai/assistant", "ai/recommendations"]
}
]
}
]
}
}
```

```json Tags in dropdowns
{
"navigation": {
"dropdowns": [
{
"dropdown": "API Reference",
"icon": "code",
"groups": [
{
"group": "REST API",
"pages": ["api/rest/overview"]
},
{
"group": "WebSocket API",
"tag": "PREVIEW",
"icon": "plug",
"pages": ["api/websocket/connection", "api/websocket/events"]
}
]
}
]
}
}
```

```json Tags in products
{
"navigation": {
"products": [
{
"product": "Platform",
"icon": "server",
"groups": [
{
"group": "Core features",
"pages": ["platform/overview"]
},
{
"group": "Edge functions",
"tag": "NEW",
"icon": "bolt",
"pages": ["platform/edge/overview", "platform/edge/deployment"]
}
]
}
]
}
}
```

</CodeGroup>

#### Styling considerations

Tags inherit your documentation's primary color scheme by default. The visual appearance of tags varies by theme, but all themes display tags consistently next to group names in the sidebar.

Tags are automatically styled to ensure readability in both light and dark modes. No additional styling configuration is required.

Check warning on line 326 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L326

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

## 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 +499,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 502 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L502

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 +614,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 617 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L617

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 +784,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 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.

Expand Down Expand Up @@ -802,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

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

<CodeGroup>

Expand All @@ -826,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

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

<CodeGroup>
Expand Down
Loading