Skip to content

Add common docs.json patterns and troubleshooting guide#3427

Closed
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/add-docs-json-patterns-examples-38282
Closed

Add common docs.json patterns and troubleshooting guide#3427
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/add-docs-json-patterns-examples-38282

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Feb 12, 2026

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 guide

Note

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 sample docs.json configs 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.

Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
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