Skip to content

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

Closed
mintlify[bot] wants to merge 5 commits into
mainfrom
mintlify/e76f8db2
Closed

mintlify[bot] wants to merge 5 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), 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 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. 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.mdx and a new help-center article (publish-button-disabled-invalid-mdx) for the “Fix invalid MDX before publishing” tooltip, registered in docs.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.

@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 23, 2026, 2:06 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.

@mintlify

mintlify Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

No changes made; all best-practices checks passed

Source PRs

@mintlify

mintlify Bot commented Sep 23, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Split overlong hover-docs sentence in editor overview across four languages

Source PRs

@ethanpalm

Copy link
Copy Markdown
Collaborator

Closing in favor of #7463, which consolidates the recent editor UI changes and verifies them against current mint and server main. Translations regenerate after #7463 merges.

@ethanpalm ethanpalm closed this Sep 23, 2026

This branch was successfully deployed

1 active deployment
staging — d41008ad Deployed Sep 23, 2026 by mintlify[bot]
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