Update from code changes: document collaborative source mode - #7270
Closed
mintlify[bot] wants to merge 5 commits into
Closed
mintlify[bot] wants to merge 5 commits into
mintlify[bot] wants to merge 5 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Contributor
Author
|
Update from code changes updated this PR. No changes made; all best-practices checks passed Source PRs
|
Contributor
Author
|
Update from code changes updated this PR. Split overlong hover-docs sentence in editor overview across four languages Source PRs
|
Collaborator
This branch was successfully deployed
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
The web editor's source mode is now collaborative: source and visual editors share the same live document, cursors and selections project across modes, and frontmatter edits sync field by field. Invalid MDX or frontmatter YAML stays local to the author until fixed, and any page with invalid MDX disables the Publish button for the branch. Source mode also gains a format-document shortcut (Cmd/Ctrl + S), MDX autocomplete (typing
<lists documented components with descriptions, props, and examples), and hover documentation for component and prop names (also available at the cursor with Cmd/Ctrl + .).Shipped in https://github.com/mintlify/mint/pull/10182, https://github.com/mintlify/mint/pull/10731, and https://github.com/mintlify/mint/pull/11697
Changes
editor/collaborate.mdx: note that real-time editing works across visual and source mode, and that invalid MDX/YAML stays local until repaired.editor/publish.mdx: new "Invalid MDX blocks publishing" subsection explaining the disabled Publish button.editor/index.mdx: mention both modes support real-time collaboration; describe MDX autocomplete and hover documentation in source mode.editor/keyboard-shortcuts.mdx: add the source mode format-document and show-component-documentation shortcuts.help-center/publish-button-disabled-invalid-mdx.mdx(new): symptom page for the "Fix invalid MDX before publishing" tooltip, added to the Help center group indocs.json.es/,fr/, andzh/, including new help-center pages and nav entries ines.json,fr.json, andzh.json.Context
Edits over roughly 1,000 characters in source mode prompt a confirmation dialog before applying; left undocumented as a minor UI guard rail. Collaborative source mode applies to supported MD/MDX pages; a plain, non-collaborative source editor remains for unsupported files and metadata-error recovery, which the docs don't call out to avoid over-specifying. Autocomplete and hover details intentionally kept brief on the overview page: trigger contexts, popover anchoring, and snippet-insertion mechanics are discoverable in the UI and would over-specify the docs. SEO audit skipped help-center pages because they sit in a hidden nav tab and are not indexed; all other touched pages pass the metadata checks.
Update history
Note
Low Risk
Documentation-only changes across editor and help-center pages with no runtime or security impact.
Overview
Documents collaborative source mode in the web editor: real-time editing now spans visual and source mode (shared cursors/selections, including title and description), with invalid MDX or frontmatter YAML staying local until fixed.
Expands source mode guidance on the editor overview and keyboard shortcuts: MDX component autocomplete (
<), hover and Cmd/Ctrl + . component docs, Cmd/Ctrl + S format document, and a link to real-time collaboration.Adds invalid MDX publish gating to
editor/publish.mdxand a new help-center article (publish-button-disabled-invalid-mdx) for the “Fix invalid MDX before publishing” tooltip, registered indocs.json. The same updates are mirrored in es, fr, and zh (editor pages, help-center article, and locale nav JSON).Reviewed by Cursor Bugbot for commit d41008a. Bugbot is set up for automated code reviews on this repo. Configure here.