docs: document editing docs.json directly in the web editor#5856
Open
mintlify[bot] wants to merge 2 commits into
Open
docs: document editing docs.json directly in the web editor#5856mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
1 participant
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
The web editor now lets you open
docs.jsonand edit it as raw JSON, with an apply/discard toolbar, JSON validation, and a publish-modal banner that blocks publishing while there are unapplied changes.Changes
docs.jsoneditor section with the apply shortcut.Context
Triggered by upstream mintlify/mint#7792, which adds collaborative editing of
docs.jsonin the web editor with apply-to-nav and discard flows, plus a publish-modal warning for unapplied changes.Note
Low Risk
Low risk: documentation-only updates describing the new
docs.jsonraw-edit/apply-discard flow and publish-menu blocking behavior; no runtime logic changes.Overview
Documents the new ability to edit
docs.jsonas raw JSON in the web editor, including the Apply changes/Discard toolbar, JSON validation behavior, and the Cmd/Ctrl+S shortcut.Adds guidance that publishing is blocked when
docs.jsonhas unapplied edits (publish-menu banner), and cross-links this flow from navigation and publishing docs in English, Spanish, and French.Reviewed by Cursor Bugbot for commit 91af3d4. Bugbot is set up for automated code reviews on this repo. Configure here.