Improve directory listings documentation#5259
Open
mintlify[bot] wants to merge 4 commits intomainfrom
Open
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
ethanpalm
reviewed
Apr 9, 2026
ethanpalm
reviewed
Apr 9, 2026
ethanpalm
reviewed
Apr 9, 2026
ethanpalm
reviewed
Apr 9, 2026
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
ethanpalm
reviewed
Apr 9, 2026
brandonmcconnell
approved these changes
Apr 9, 2026
Contributor
brandonmcconnell
left a comment
There was a problem hiding this comment.
looks good, some nits - there might be some redundancy too fyi
| ### Directory listings | ||
|
|
||
| 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. | ||
| Use the `directory` property to automatically render a directory of child pages on group root pages. When you set `directory` on a navigation element, any group with a `root` page beneath that element displays a listing of its pages below the page content. |
Contributor
There was a problem hiding this comment.
Suggested change
| Use the `directory` property to automatically render a directory of child pages on group root pages. When you set `directory` on a navigation element, any group with a `root` page beneath that element displays a listing of its pages below the page content. | |
| Use the `directory` property to automatically render a directory of child pages and groups on group root pages. When you set `directory` on any object within the `navigation` tree in `docs.json`, groups with a `root` page matching or beneath that object display a listing of their pages and groups below their page contents. |
| | `"card"` | Displays child pages in a horizontal card layout. | | ||
|
|
||
| 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. | ||
| The `directory` value inherits recursively through the navigation tree. Set it on a parent navigation element and all descendant groups inherit the same value. Any descendant can override the inherited value by setting `"directory": "none"`. |
Contributor
There was a problem hiding this comment.
Suggested change
| The `directory` value inherits recursively through the navigation tree. Set it on a parent navigation element and all descendant groups inherit the same value. Any descendant can override the inherited value by setting `"directory": "none"`. | |
| The `directory` value inherits recursively through the navigation tree. Set it on anywhere within the navigation object and all descendant groups inherit the same value. Any descendant can override the inherited value by setting `directory` to a different value. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to #5200, incorporating improvements from #5242.
Changes
directorycan be set anywhere in the navigation object (not just groups, tabs, or the top-levelnavigation)Note
Low Risk
Documentation-only updates that clarify
navigation.directorybehavior and inheritance/override rules; low risk aside from potential confusion if wording is inaccurate.Overview
Updates the Directory listings docs to better explain how
navigation.directoryworks (what it renders, inheritance/override behavior, and that it can be set anywhere in the navigation tree), and replaces the prior examples with a single inheritance-focused example.Aligns the
docs.jsonschema docs by shortening thenavigation.directoryreference entry, linking back to the main section, and updating the settings-structure type annotation to an explicit union ("none" | "accordion" | "card").Reviewed by Cursor Bugbot for commit 386fbd4. Bugbot is set up for automated code reviews on this repo. Configure here.