Skip to content

Add documentation for products navigation division #1431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Add documentation for products navigation division #1431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0dba7a8
Update organize/settings.mdx
mintlify-development[bot] Oct 3, 2025
2db3788
Update organize/settings.mdx
mintlify-development[bot] Oct 3, 2025
1960cee
Update organize/navigation.mdx
mintlify-development[bot] Oct 3, 2025
8fd7b62
Update organize/navigation.mdx
mintlify-development[bot] Oct 3, 2025
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
46 changes: 46 additions & 0 deletions organize/navigation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,6 +514,10 @@ For automated translations, [contact our sales team](mailto:gtm@mintlify.com) to

You can use any combination of anchors, tabs, dropdowns, and products. The components can be nested within each other interchangeably to create your desired navigation structure.

<Note>
Products are particularly useful for organizing documentation for multiple distinct offerings or services within a single documentation site.
</Note>

<CodeGroup>

```json Anchors
Expand Down Expand Up @@ -630,6 +634,48 @@ You can use any combination of anchors, tabs, dropdowns, and products. The compo
}
```

```json Products
{
"navigation": {
"products": [
{
"product": "Product 1",
"icon": "rocket",
"groups": [
{
"group": "Getting started",
"pages": [
"product-1/quickstart",
"product-1/setup"
]
},
{
"group": "Features",
"pages": [
"product-1/feature-a",
"product-1/feature-b"
]
}
]
},
{
"product": "Product 2",
"icon": "chart-bar",
"groups": [
{
"group": "Getting started",
"pages": [
"product-2/overview",
"product-2/installation"
]
}
]
}
]
}
}
```

</CodeGroup>

## Breadcrumbs
Expand Down
23 changes: 23 additions & 0 deletions organize/settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,25 @@ See [Themes](themes) for more information.
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField name="products" type="array of object">
Product divisions for organizing product-specific documentation.

<Expandable title="Products">
<ResponseField name="product" type="string" required>
Display name of the product.

Minimum length: 1
</ResponseField>
<IconsOptional />
<ResponseField name="hidden" type="boolean">
Whether to hide this product by default.
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
URL or path for the product destination.
</ResponseField>
</Expandable>
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="languages" type="array of object">
Expand All @@ -475,6 +494,10 @@ See [Themes](themes) for more information.
<ResponseField name="dropdowns" type="array of object">
[Dropdowns](navigation#dropdowns) for grouping related content.

</ResponseField>
<ResponseField name="products" type="array of object">
[Products](navigation#products) for organizing product-specific documentation.

</ResponseField>
<ResponseField name="groups" type="array of object">
[Groups](navigation#groups) for organizing content into sections.
Expand Down
Loading