docs: document MDX comment syntax#6029
Merged
Merged
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 Workflows to automatically generate PRs for you. |
ethanpalm
approved these changes
May 29, 2026
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
2 participants
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
Adds a brief "Comments" section to the text formatting page documenting the MDX
{/* ... */}comment syntax for non-rendering source notes.Changes
create/text.mdx: New "Comments" section with single-line and multi-line examples, plus a callout that HTML-style<!-- -->comments are not supported.Context
Recent assistant conversations showed users asking how to add reviewer notes or to-dos in MDX that don't render. The syntax was referenced in
deploy/ci.mdx(Vale integration) but never explained as a general authoring feature, leading to unanswered queries.Note
Low Risk
Documentation-only additions with no runtime, auth, or data-handling impact.
Overview
Adds a Comments section to the text-formatting guide (
create/text.mdxand Spanish/French equivalents) explaining how to use MDX{/* ... */}for source-only notes, TODOs, and reviewer comments that do not appear on the published page.The section includes single- and multi-line examples and a Warning that HTML
<!-- -->comments are not supported in MDX. Localized pages use the same content with acommentsanchor wrapper where the rest of those guides usedivIDs for headings.Reviewed by Cursor Bugbot for commit 8853245. Bugbot is set up for automated code reviews on this repo. Configure here.