Document composable docs.json with $ref support#4620
Closed
mintlify[bot] wants to merge 3 commits intomainfrom
Closed
Document composable docs.json with $ref support#4620mintlify[bot] wants to merge 3 commits intomainfrom
mintlify[bot] wants to merge 3 commits intomainfrom
Conversation
Generated-By: mintlify-agent
Generated-By: mintlify-agent
Generated-By: mintlify-agent
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
$ref" section to the global settings pagedocs.jsoninto multiple filesRelates to mintlify/mint#6584.
Note
Low Risk
Documentation-only change that adds guidance for
$refusage indocs.json, with no runtime or configuration parsing logic modified.Overview
Adds a new “Composable configuration with
$ref” section toorganize/settings.mdxdescribing how to splitdocs.jsoninto multiple local JSON files.Includes examples for basic and nested
$refusage, 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.