Skip to content

Document the expanded field in navigation page for groups auto expanding in sidenav #1129

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

Merged
merged 2 commits into from
Sep 13, 2025
Merged

Document the expanded field in navigation page for groups auto expanding in sidenav #1129

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b782d15
Update navigation.mdx
mintlify[bot] Sep 13, 2025
5adc84f
fix: Set default expanded state to false for 'Getting started' group …
skeptrunedev Sep 13, 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
15 changes: 14 additions & 1 deletion navigation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
alt=""
/>

In the `navigation` object, `groups` is an array where each entry is an object that requires a `group` field and a `pages` field. The `icon` and `tag` fields are optional.
In the `navigation` object, `groups` is an array where each entry is an object that requires a `group` field and a `pages` field. The `icon`, `tag`, and `expanded` fields are optional.

```json
{
Expand All @@ -66,6 +66,7 @@
{
"group": "Getting started",
"icon": "play",
"expanded": false,
"pages": [
"quickstart",
{
Expand All @@ -92,6 +93,18 @@
}
```

### Default expanded state

Set `expanded: true` on a group to make it expanded by default in the navigation sidebar. This is useful for highlighting important sections or improving discoverability of key content.

Check warning on line 98 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L98 

Did you really mean 'discoverability'?

```json
{
"group": "Getting started",
"expanded": true,
"pages": ["quickstart", "installation"]
}
```

## 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