From 813ae619e26d64c494a8030ad2b0a4e32e0fe2d3 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 27 Jan 2026 22:44:25 +0000 Subject: [PATCH] Update organize/navigation.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- organize/navigation.mdx | 206 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 206 insertions(+) diff --git a/organize/navigation.mdx b/organize/navigation.mdx index df6913b9c..bddd88032 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -119,6 +119,212 @@ Use the `expanded` property to control the default state of a nested group in th } ``` +### 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. + +Navigation groups with tags displayed in the sidebar. + +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 +- **BETA**: Indicate features that are in beta or preview status +- **DEPRECATED**: Mark content that will be removed or replaced in future versions +- **UPDATED**: Draw attention to recently refreshed documentation +- **PREVIEW**: Identify early-access features or experimental functionality + +Keep tag text short and clear. Tags with more than 12 characters 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: + + + +```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"] + } + ] + } + ] + } +} +``` + + + +#### 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. + ## 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.