Skip to content

Update from code changes: document collaborative source mode - #7270

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/e76f8db2
Open

Update from code changes: document collaborative source mode#7270
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/e76f8db2

Conversation

@mintlify

@mintlify mintlify Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

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).

Shipped in https://github.com/mintlify/mint/pull/10182

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.
  • editor/keyboard-shortcuts.mdx: add the source mode format-document shortcut.
  • 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 in docs.json.
  • Translations: mirrored all of the above into es/, fr/, and zh/, including new help-center pages and nav entries in es.json, fr.json, and zh.json.
  • Style pass: split an overlong sentence and switched one passive construction to active voice on the new help-center page.

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. 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.


Note

Low Risk
Documentation-only updates across editor and help-center MDX and locale nav JSON; no application or deployment logic changes.

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 and only valid content syncing to teammates.

Adds an Invalid MDX blocks publishing section on the publish docs and a new Help center article for the disabled Publish / “Fix invalid MDX before publishing” tooltip, registered in docs.json and localized (es, fr, zh). Editor overview and collaborate pages cross-link the behavior; source-mode shortcuts now list Format document (Cmd/Ctrl + S).

Reviewed by Cursor Bugbot for commit 6c98890. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
mintlify 🟢 Ready View Preview Sep 5, 2026, 7:47 AM

@mintlify

mintlify Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
tomee 🟡 Building Sep 5, 2026, 7:46 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

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.

0 participants