Skip to content

Improve directory listings documentation#5259

Open
mintlify[bot] wants to merge 4 commits intomainfrom
mintlify/directory-docs-followup-1775775250
Open

Improve directory listings documentation#5259
mintlify[bot] wants to merge 4 commits intomainfrom
mintlify/directory-docs-followup-1775775250

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify bot commented Apr 9, 2026

Summary

Follow-up to #5200, incorporating improvements from #5242.

Changes

  • organize/navigation.mdx: Rewrote the directory listings section with clearer descriptions, a single example demonstrating inheritance and override behavior, and clarified that directory can be set anywhere in the navigation object (not just groups, tabs, or the top-level navigation)
  • organize/settings-reference.mdx: Condensed the reference entry and linked to the main docs section
  • organize/settings-structure.mdx: Updated the type annotation to show explicit union values and improved the description

Note

Low Risk
Documentation-only updates that clarify navigation.directory behavior 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.directory works (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.json schema docs by shortening the navigation.directory reference 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.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify bot commented Apr 9, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 9, 2026, 10:57 PM

@mintlify-development
Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
userauth 🟡 Building Apr 9, 2026, 10:54 PM

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@brandonmcconnell brandonmcconnell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants