docs: add Rslib v1 upgrade guide - #1805
Merged
Merged
Conversation
Deploying rslib with
|
| Latest commit: |
76bc1b9
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://487db3b3.rslib.pages.dev |
| Branch Preview URL: | https://david-docs-rslib-v1-upgrade.rslib.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds new bilingual (EN/ZH) upgrade documentation for migrating from Rslib 0.x to v1, and reorganizes the docs sidebar to introduce a dedicated Upgrade section.
Changes:
- Add EN/ZH “v0 to v1” migration guides describing breaking changes and recommended config updates.
- Add EN/ZH “Upgrade Rslib” guide documenting versioning, changelogs, and using Taze to update dependencies.
- Move the general upgrade guide entry out of “Basic” and into a new “Upgrade” docs section via
_meta.jsonupdates.
Reviewed changes
Copilot reviewed 8 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/guide/upgrade/v0-to-v1.mdx | New EN v0→v1 migration guide content. |
| website/docs/en/guide/upgrade/upgrade-rslib.mdx | New EN “Upgrade Rslib” guide (Taze workflow, versioning, links). |
| website/docs/en/guide/upgrade/_meta.json | Adds the new EN Upgrade section navigation ordering. |
| website/docs/en/guide/basic/_meta.json | Removes upgrade-rslib from the EN Basic section nav. |
| website/docs/en/guide/_meta.json | Adds EN “Upgrade” directory section header to the guide sidebar. |
| website/docs/zh/guide/upgrade/v0-to-v1.mdx | New ZH v0→v1 migration guide content. |
| website/docs/zh/guide/upgrade/upgrade-rslib.mdx | New ZH “升级 Rslib” guide (Taze workflow, versioning, links). |
| website/docs/zh/guide/upgrade/_meta.json | Adds the new ZH Upgrade section navigation ordering. |
| website/docs/zh/guide/basic/_meta.json | Removes upgrade-rslib from the ZH Basic section nav. |
| website/docs/zh/guide/_meta.json | Adds ZH “升级” directory section header to the guide sidebar. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 76bc1b9822
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
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
Rslib v1 introduces behavior and configuration changes that users need to account for when upgrading from 0.x. This PR adds bilingual v0-to-v1 migration guides covering Rsbuild v2 compatibility, syntax target and
externalsTypeupdates, native TypeScript handling, configuration migrations, and JavaScript API changes. It also moves the general upgrade guide into a dedicated Upgrade section.Related Links
Checklist