Add common docs.json patterns and troubleshooting guide#3427
Closed
mintlify[bot] wants to merge 1 commit intomainfrom
Closed
Add common docs.json patterns and troubleshooting guide#3427mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
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.
Added a comprehensive section to organize/settings.mdx with complete working examples of docs.json configurations for different use cases (simple site, API docs with OpenAPI, multi-language, and versioned documentation). Includes detailed troubleshooting guidance for common configuration issues like JSON syntax errors, navigation problems, OpenAPI integration, and validation.
Files changed
organize/settings.mdx- Added "Common docs.json patterns and examples" section with 4 complete configuration examples and troubleshooting guideNote
Low Risk
Documentation-only changes that add examples and guidance; no runtime or configuration parsing logic is modified.
Overview
Adds a new “Common docs.json patterns and examples” section to
organize/settings.mdx, providing full sampledocs.jsonconfigs for a simple docs site, an OpenAPI-powered API reference (including playground and code-sample settings), multi-language navigation, and versioned documentation.Also adds a Troubleshooting guide covering common configuration pitfalls (JSON syntax issues, missing navigation pages, OpenAPI path/endpoint generation problems, color format mistakes) plus schema/validation best practices before deployment.
Written by Cursor Bugbot for commit b18458c. This will update automatically on new commits. Configure here.