docs(migration): add mdxRs option removal to migration guide#3196
Merged
SoonIter merged 1 commit intoweb-infra-dev:mainfrom Mar 4, 2026
Merged
docs(migration): add mdxRs option removal to migration guide#3196SoonIter merged 1 commit intoweb-infra-dev:mainfrom
SoonIter merged 1 commit intoweb-infra-dev:mainfrom
Conversation
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Tatsunori Uchino <tats.u@live.jp>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds missing migration-guide documentation for the removal of the markdown.mdxRs config option in Rspress v2, aligning the migration docs with the v2 announcement blog so users understand the resulting TypeScript config/type errors.
Changes:
- Add
markdown.mdxRsremoval to the quick migration checklist (EN/ZH). - Add a dedicated migration section explaining that
markdown.mdxRsis removed and should be deleted from config, with before/after examples (EN/ZH).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/docs/zh/guide/migration/rspress-1-x.mdx | Documents markdown.mdxRs removal in the Chinese migration guide, including checklist + before/after config example. |
| website/docs/en/guide/migration/rspress-1-x.mdx | Documents markdown.mdxRs removal in the English migration guide, including checklist + before/after config example. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
SoonIter
approved these changes
Mar 4, 2026
Member
|
thanks ❤~ |
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
The Rspress 2.0 migration guide omits the removal of markdown.mdxRs, though the blog announcement covers it. Users keeping this option hit TypeScript type errors with no explanation in the migration docs.
Notice: Copilot powered by Claude Opus 4.6 was used
Related Issue
Followup of the PRs #2940, #2954, #3075
Checklist