Skip to content
Merged
Show file tree
Hide file tree
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
32 changes: 32 additions & 0 deletions organize/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,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 123 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L123

In general, use active voice instead of passive voice ('is expanded').
- `expanded: false` or omitted: Group is collapsed by default.

Check warning on line 124 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L124

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L127

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

```json
Expand Down Expand Up @@ -515,6 +515,38 @@
}
```

### Default version

The first version in the `versions` array is used as the default version. Use the `default` field to specify a different version as the default.

Check warning on line 520 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L520

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

```json
{
"navigation": {
"versions": [
{
"version": "1.0.0",
"groups": [
{
"group": "Getting started",
"pages": ["v1/overview", "v1/quickstart"]
}
]
},
{
"version": "2.0.0",
"default": true,
"groups": [
{
"group": "Getting started",
"pages": ["v2/overview", "v2/quickstart"]
}
]
}
]
}
}
```

### Version tags

Add a badge label to version entries in the version selector dropdown using the optional `tag` field. Use tags to highlight specific versions such as "Latest," "Recommended," or "Beta."
Expand Down Expand Up @@ -695,7 +727,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 730 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L730

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
3 changes: 3 additions & 0 deletions organize/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -348,11 +348,11 @@
</ResponseField>

<ResponseField name="variables" type="object">
Global variables for use throughout your documentation. Variables are replaced at build time using `{{variableName}}` syntax.

Check warning on line 351 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L351

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

<Expandable title="Variables">
<ResponseField name="variableName" type="string">
A key-value pair where the key is the variable name and the value is the replacement text. All variables referenced in your content must be defined, or the build fails. Variable names can contain alphanumeric characters, hyphens, and periods. Values are sanitized to prevent XSS attacks.

Check warning on line 355 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L355

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

Check warning on line 355 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L355

In general, use active voice instead of passive voice ('are sanitized').
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -559,6 +559,9 @@
Version switcher for sites with multiple [versions](/organize/navigation#versions).

<Expandable title="Versions">
<ResponseField name="default" type="boolean">
Set to `true` to make this version the default. If omitted or `false`, the first version in the array is the default.
</ResponseField>
<ResponseField name="tag" type="string">
Badge label displayed next to the version in the version selector. Use to highlight specific versions such as "Latest", "Recommended", or "Beta."
</ResponseField>
Expand Down
Loading