You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Address two recurring documentation gaps surfaced by recent assistant conversations: how to escape MDX special characters, and how to place a standalone page (such as an overview) above other groups in the sidebar.
Changes
create/text.mdx: Add an "Escape special characters" section covering {, }, <, backticks, and backslashes, with a note that escaping is not required inside fenced code blocks.
organize/navigation.mdx: Add a "Mix standalone pages with groups" subsection showing how to wrap navigation in a single top-level group whose pages array mixes string page paths with nested group objects, and cross-link to the existing root page pattern.
Context
Recent assistant threads showed users asking how to escape variables in MDX (no current docs coverage) and how to place an overview link above a list of groups in the sidebar (a thread that received negative feedback because the answer was not clearly documented).
Note
Low Risk
Documentation-only MDX changes with no runtime, auth, or config behavior impact.
Overview
Adds documentation for two common author questions: how to show MDX special characters as literal text, and how to pin a standalone overview link above nested sidebar groups.
In create/text.mdx (plus es and fr locales), a new Escape special characters section explains why {, }, and < are parsed as JSX, lists escape options (backticks, HTML entities, JSX string expressions), and notes that fenced code blocks do not require escaping.
In organize/navigation.mdx (en, es, fr), a new Mix standalone pages with groups subsection documents wrapping nav in one top-level group whose pages array interleaves a string path (e.g. overview) with nested group objects, with a sample docs.json and a pointer to the existing root page pattern.
Reviewed by Cursor Bugbot for commit 799a41e. Bugbot is set up for automated code reviews on this repo. Configure here.
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
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
Address two recurring documentation gaps surfaced by recent assistant conversations: how to escape MDX special characters, and how to place a standalone page (such as an overview) above other groups in the sidebar.
Changes
create/text.mdx: Add an "Escape special characters" section covering{,},<, backticks, and backslashes, with a note that escaping is not required inside fenced code blocks.organize/navigation.mdx: Add a "Mix standalone pages with groups" subsection showing how to wrap navigation in a single top-level group whosepagesarray mixes string page paths with nested group objects, and cross-link to the existingrootpage pattern.Context
Recent assistant threads showed users asking how to escape variables in MDX (no current docs coverage) and how to place an overview link above a list of groups in the sidebar (a thread that received negative feedback because the answer was not clearly documented).
Note
Low Risk
Documentation-only MDX changes with no runtime, auth, or config behavior impact.
Overview
Adds documentation for two common author questions: how to show MDX special characters as literal text, and how to pin a standalone overview link above nested sidebar groups.
In
create/text.mdx(plusesandfrlocales), a new Escape special characters section explains why{,}, and<are parsed as JSX, lists escape options (backticks, HTML entities, JSX string expressions), and notes that fenced code blocks do not require escaping.In
organize/navigation.mdx(en,es,fr), a new Mix standalone pages with groups subsection documents wrapping nav in one top-levelgroupwhosepagesarray interleaves a string path (e.g.overview) with nestedgroupobjects, with a sampledocs.jsonand a pointer to the existing root page pattern.Reviewed by Cursor Bugbot for commit 799a41e. Bugbot is set up for automated code reviews on this repo. Configure here.