docs: add upgrade-rstest guide
#714
Conversation
✅ Deploy Preview for rstest-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR adds a new documentation guide for upgrading Rstest dependencies in both English and Chinese. The guide introduces users to Taze, a CLI tool for updating npm dependencies, and provides practical examples of how to upgrade Rstest packages using various Taze options. This documentation helps users keep their Rstest dependencies up to date, which is particularly important given that Rstest is still in the 0.x version stage where API changes can occur frequently.
- Added comprehensive upgrade guide using the Taze CLI tool
- Documented common upgrade scenarios including monorepo and locked version handling
- Included both English and Chinese translations for international audience
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| website/docs/en/guide/basic/upgrade-rstest.mdx | New English documentation page explaining how to upgrade Rstest dependencies using Taze |
| website/docs/zh/guide/basic/upgrade-rstest.mdx | New Chinese documentation page with the same upgrade guide content |
| website/docs/en/guide/basic/_meta.json | Added "upgrade-rstest" to the navigation menu for English docs |
| website/docs/zh/guide/basic/_meta.json | Added "upgrade-rstest" to the navigation menu for Chinese docs |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
| - To upgrade to a major version: | ||
|
|
||
| ```bash | ||
| npx taze major --include /(rstest|rsbuild)/ -w |
There was a problem hiding this comment.
[nitpick] This "To upgrade to a major version" example shows the exact same command as the initial usage example on line 20. This redundancy may confuse readers. Consider either removing this duplicate example or demonstrating a different use case (e.g., upgrading to a minor version without the major parameter).
| - To upgrade to a major version: | |
| ```bash | |
| npx taze major --include /(rstest|rsbuild)/ -w | |
| - To upgrade to a minor or patch version (for packages that support it): | |
| ```bash | |
| npx taze --include /(rstest|rsbuild)/ -w |
| - 升级到 major 版本： | ||
|
|
||
| ```bash | ||
| npx taze major --include /(rstest|rsbuild)/ -w |
There was a problem hiding this comment.
[nitpick] This "升级到 major 版本" example shows the exact same command as the initial usage example on line 20. This redundancy may confuse readers. Consider either removing this duplicate example or demonstrating a different use case (e.g., upgrading to a minor version without the major parameter).
| - 升级到 major 版本： | |
| ```bash | |
| npx taze major --include /(rstest|rsbuild)/ -w | |
| - 升级到 minor 版本（不带 `major` 参数，仅升级到最新的 minor 或 patch 版本）： | |
| ```bash | |
| npx taze minor --include /(rstest|rsbuild)/ -w |
|
|
||
| Rstest 尚未达到 1.0.0 版本，因此你需要在更新时添加 `major` 参数。 | ||
|
|
There was a problem hiding this comment.
[nitpick] The :::tip block has unnecessary blank lines (lines 24 and 26). Based on the codebase convention seen in other files, single-paragraph admonition blocks should not have blank lines inside. This should match the English version format:
:::tip
Rstest 尚未达到 1.0.0 版本，因此你需要在更新时添加 `major` 参数。
:::
| Rstest 尚未达到 1.0.0 版本，因此你需要在更新时添加 `major` 参数。 | |
| Rstest 尚未达到 1.0.0 版本，因此你需要在更新时添加 `major` 参数。 |
Summary
add
upgrade-rstestguideRelated Links
Checklist