Skip to content

Document composable docs.json with $ref support#4620

Closed
mintlify[bot] wants to merge 3 commits intomainfrom
mintlify/composable-docs-json-1773784060
Closed

Document composable docs.json with $ref support#4620
mintlify[bot] wants to merge 3 commits intomainfrom
mintlify/composable-docs-json-1773784060

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Mar 17, 2026

Summary

  • Adds a new "Composable configuration with $ref" section to the global settings page
  • Documents basic usage, nested references, and rules/limitations for splitting docs.json into multiple files

Relates to mintlify/mint#6584.


Note

Low Risk
Documentation-only change that adds guidance for $ref usage in docs.json, with no runtime or configuration parsing logic modified.

Overview
Adds a new “Composable configuration with $ref section to organize/settings.mdx describing how to split docs.json into multiple local JSON files.

Includes examples for basic and nested $ref usage, notes how sibling keys override/extend referenced objects, and documents key constraints (relative local paths, circular ref detection, project-root path restrictions, and merge behavior).

Written by Cursor Bugbot for commit 90eb454. This will update automatically on new commits. Configure here.

@ethanpalm ethanpalm closed this Mar 20, 2026
@ethanpalm ethanpalm deleted the mintlify/composable-docs-json-1773784060 branch March 20, 2026 23:49
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.

1 participant