docs: update guide of creating an Rslib project#1468
Merged
Timeless0911 merged 2 commits intomainfrom Jan 30, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the English and Chinese Quick Start documentation to reflect the latest create-rslib features and usage patterns. The changes expand tooling/options coverage, add Deno support, and refine the non-interactive CLI usage examples and reference.
Changes:
- Add
denoas a package manager option in the Quick Start command tabs. - Update template and optional tools sections to cover Rspress, Storybook, Rstest, Vitest, and clarify how they relate to templates.
- Revise the “Non-interactive mode” section to show up-to-date
npxusage, the[dir]argument,--packageName, and the full set of templates and optional tools.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
website/docs/en/guide/start/quick-start.mdx |
Refreshes the English Quick Start guide with new templates/tools, Deno usage, and updated non-interactive CLI examples and options table. |
website/docs/zh/guide/start/quick-start.mdx |
Mirrors the English updates in Chinese, aligning templates, optional tools, Deno usage, and non-interactive mode descriptions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Deploying rslib with
|
| Latest commit: |
11c1d28
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://77270222.rslib.pages.dev |
| Branch Preview URL: | https://docs-update-quick-start.rslib.pages.dev |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
This PR updates the Quick Start guide in both English and Chinese to align with the latest
create-rslibfeatures.denoto the package manager tabs.--packageNameand the[dir]argument.Related Links
N/A
Checklist