From fb328a3956c82e7c6ac9d4da3c6cb3fe164b004d Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Tue, 7 Apr 2026 23:30:57 +0000
Subject: [PATCH 1/2] Add documentation for directory listings on group root
pages
Generated-By: mintlify-agent
---
organize/navigation.mdx | 53 +++++++++++++++++++++++++++++++++
organize/settings-reference.mdx | 7 +++++
organize/settings-structure.mdx | 4 +++
3 files changed, 64 insertions(+)
diff --git a/organize/navigation.mdx b/organize/navigation.mdx
index 421b8a9ab..f338458ea 100644
--- a/organize/navigation.mdx
+++ b/organize/navigation.mdx
@@ -116,6 +116,59 @@ Use the `root` property to designate a main page for a group. When a group has a
}
```
+### Directory listings
+
+When a group has a root page, you can automatically generate a directory listing on that page. The directory listing displays the group's child pages and nested groups, giving users an overview of the section's content.
+
+Set the `directory` property on a group, tab, or the top-level `navigation` object to enable directory listings. The property accepts three values:
+
+- `"accordion"` — displays child pages in a compact list layout.
+- `"card"` — displays child pages as horizontal cards.
+- `"none"` — disables directory listings (default).
+
+The `directory` value inherits through the navigation hierarchy. Setting it on a parent element applies to all descendant groups unless overridden.
+
+```json Enable accordion directory for a group
+{
+ "navigation": {
+ "groups": [
+ {
+ "group": "API reference",
+ "root": "api-overview",
+ "directory": "accordion",
+ "pages": [
+ "api-reference/authentication",
+ "api-reference/endpoints",
+ "api-reference/errors"
+ ]
+ }
+ ]
+ }
+}
+```
+
+```json Enable card directory for all groups
+{
+ "navigation": {
+ "directory": "card",
+ "groups": [
+ {
+ "group": "Guides",
+ "root": "guides/overview",
+ "pages": [
+ "guides/quickstart",
+ "guides/configuration"
+ ]
+ }
+ ]
+ }
+}
+```
+
+
+ Directory listings only appear on group root pages. Groups without a `root` property are not affected by the `directory` setting.
+
+
### Default expanded state
Use the `expanded` property to control the default state of a nested group in the navigation sidebar.
diff --git a/organize/settings-reference.mdx b/organize/settings-reference.mdx
index 4671d91a9..06fcea970 100644
--- a/organize/settings-reference.mdx
+++ b/organize/settings-reference.mdx
@@ -231,6 +231,13 @@ Individual pages in your documentation.
**Type:** array of string or object
+#### `navigation.directory`
+
+Directory layout for group root pages. When set to `"accordion"` or `"card"`, groups with a `root` page automatically display a directory listing of their child pages. Set to `"none"` to disable. Inherits recursively through the navigation hierarchy; descendants can override.
+
+**Type:** `"none"` | `"accordion"` | `"card"`
+**Default:** `"none"`
+
---
### `description`
diff --git a/organize/settings-structure.mdx b/organize/settings-structure.mdx
index 9a90d9703..78f826c5a 100644
--- a/organize/settings-structure.mdx
+++ b/organize/settings-structure.mdx
@@ -201,6 +201,10 @@ See [Navigation](/organize/navigation) for complete documentation on building yo
Individual [pages](/organize/navigation#pages) that make up your documentation.
+
+ Directory layout for group root pages. Set to `"accordion"` or `"card"` to automatically display a listing of child pages on group root pages. Set to `"none"` to disable. Inherits recursively; descendants can override. See [Directory listings](/organize/navigation#directory-listings).
+
+
---
### `navbar`
From 33e8617b085fa64efb23a34371df1702fabea4a8 Mon Sep 17 00:00:00 2001
From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Date: Wed, 8 Apr 2026 16:17:10 -0700
Subject: [PATCH 2/2] copy edit
---
organize/navigation.mdx | 18 ++++++++++--------
organize/settings-reference.mdx | 2 +-
organize/settings-structure.mdx | 2 +-
3 files changed, 12 insertions(+), 10 deletions(-)
diff --git a/organize/navigation.mdx b/organize/navigation.mdx
index f338458ea..5a7b8b642 100644
--- a/organize/navigation.mdx
+++ b/organize/navigation.mdx
@@ -118,17 +118,19 @@ Use the `root` property to designate a main page for a group. When a group has a
### Directory listings
-When a group has a root page, you can automatically generate a directory listing on that page. The directory listing displays the group's child pages and nested groups, giving users an overview of the section's content.
+When a group has a root page, you can generate a directory listing on that page. The directory listing displays the group's child pages and nested groups to give users an overview of the section's content.
Set the `directory` property on a group, tab, or the top-level `navigation` object to enable directory listings. The property accepts three values:
-- `"accordion"` — displays child pages in a compact list layout.
-- `"card"` — displays child pages as horizontal cards.
-- `"none"` — disables directory listings (default).
+| Value | Description |
+|---------------|----------------------------------------------------|
+| `"accordion"` | Displays child pages in a list |
+| `"card"` | Displays child pages as horizontal cards |
+| `"none"` | Disables directory listings (default) |
-The `directory` value inherits through the navigation hierarchy. Setting it on a parent element applies to all descendant groups unless overridden.
+The `directory` value inherits through the navigation hierarchy. If you set a `directory` value on a parent element, the value applies to all descendant groups unless overridden.
-```json Enable accordion directory for a group
+```json Enable accordion directory for a group {6}
{
"navigation": {
"groups": [
@@ -147,7 +149,7 @@ The `directory` value inherits through the navigation hierarchy. Setting it on a
}
```
-```json Enable card directory for all groups
+```json Enable card directory for all groups {3}
{
"navigation": {
"directory": "card",
@@ -166,7 +168,7 @@ The `directory` value inherits through the navigation hierarchy. Setting it on a
```
- Directory listings only appear on group root pages. Groups without a `root` property are not affected by the `directory` setting.
+ Directory listings only appear on group root pages. If a group does not have a `root` property, it cannot display a directory listing.
### Default expanded state
diff --git a/organize/settings-reference.mdx b/organize/settings-reference.mdx
index 06fcea970..6ea279187 100644
--- a/organize/settings-reference.mdx
+++ b/organize/settings-reference.mdx
@@ -233,7 +233,7 @@ Individual pages in your documentation.
#### `navigation.directory`
-Directory layout for group root pages. When set to `"accordion"` or `"card"`, groups with a `root` page automatically display a directory listing of their child pages. Set to `"none"` to disable. Inherits recursively through the navigation hierarchy; descendants can override.
+Directory layout for group root pages. When set to `"accordion"` or `"card"`, groups with a `root` page display a directory listing of their child pages. Set to `"none"` to disable. Inherits recursively through the navigation hierarchy; descendants can override.
**Type:** `"none"` | `"accordion"` | `"card"`
**Default:** `"none"`
diff --git a/organize/settings-structure.mdx b/organize/settings-structure.mdx
index 78f826c5a..b6098f688 100644
--- a/organize/settings-structure.mdx
+++ b/organize/settings-structure.mdx
@@ -202,7 +202,7 @@ See [Navigation](/organize/navigation) for complete documentation on building yo
- Directory layout for group root pages. Set to `"accordion"` or `"card"` to automatically display a listing of child pages on group root pages. Set to `"none"` to disable. Inherits recursively; descendants can override. See [Directory listings](/organize/navigation#directory-listings).
+ Directory layout for group root pages. Set to `"accordion"` or `"card"` to display a listing of child pages on group root pages. Set to `"none"` to disable. Inherits recursively; descendants can override. See [Directory listings](/organize/navigation#directory-listings) for more information.
---