Fill gaps from assistant conversations: snippet identifier rules#6727
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
reviewed
Jul 24, 2026
ethanpalm
reviewed
Jul 24, 2026
ethanpalm
reviewed
Jul 24, 2026
ethanpalm
reviewed
Jul 24, 2026
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
ethanpalm
approved these changes
Jul 24, 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
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
Clarify the naming rules for the identifier used when importing a reusable snippet, addressing recurring assistant questions about which identifiers are valid.
Changes
create/reusable-snippets.mdxexplaining that the import name must be a valid JSX component identifier (PascalCase, uppercase first letter) and that lowercase names are treated as HTML elements.Context
Assistant conversations this week showed users asking what identifiers work when inserting a snippet. The existing page shows PascalCase in examples but does not state the requirement explicitly.
Note
Low Risk
Documentation-only edits to MDX guides; no runtime, auth, or data paths affected.
Overview
Documents a gap in the reusable snippets guide: snippet tags must use an uppercase-first identifier (e.g.
MySnippet) so MDX treats them as components, not lowercase HTML/custom elements like<mySnippet />.The new note sits under Import snippets into pages in
create/reusable-snippets.mdx, with matching copy in es, fr, and zh (locales also mention PascalCase as convention where the English page does not). es, fr, and zh also get a trailing newline fix on the React import example code fence.Reviewed by Cursor Bugbot for commit df4b49b. Bugbot is set up for automated code reviews on this repo. Configure here.