Skip to content

docs: update quick start to use @rspress/core instead of rspress#3106

Merged
SoonIter merged 1 commit intomainfrom
syt-vibe-kanban/eaaf-npm-install-rspr
Feb 4, 2026
Merged

docs: update quick start to use @rspress/core instead of rspress#3106
SoonIter merged 1 commit intomainfrom
syt-vibe-kanban/eaaf-npm-install-rspr

Conversation

@SoonIter
Copy link
Copy Markdown
Member

@SoonIter SoonIter commented Feb 4, 2026 •
edited
Loading

Summary

Related Issue

#3104

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

AI Summary

What changed

Updated the "Quick Start" documentation in both Chinese (zh) and English (en) versions to change the package installation command from rspress to @rspress/core.

Files modified:

  • website/docs/zh/guide/start/getting-started.mdx
  • website/docs/en/guide/start/getting-started.mdx

Why

The package name rspress has been deprecated in favor of @rspress/core. The documentation needed to be updated to reflect the correct package name that users should install.

Details

Changed the <PackageManagerTabs> component command from:

install rspress -D

to:

install @rspress/core -D

This PR was written using Vibe Kanban

@SoonIter
已完成修改。将中文和英文版本的"快速开始"文档中的 npm install rspress 改为了 `npm install @rsp…
d58afec 
…ress/core`：

- `website/docs/zh/guide/start/getting-started.mdx:29`
- `website/docs/en/guide/start/getting-started.mdx:29`
Copilot AI review requested due to automatic review settings February 4, 2026 03:18
@SoonIter SoonIter changed the title 修改 “快速开始” 中的 npm install rspress ，改为 @rspress/core (vibe-kanban) docs: update quick start to use @rspress/core instead of rspress Feb 4, 2026
Copilot AI reviewed Feb 4, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request updates the installation command in the "Quick Start" documentation to use the correct package name @rspress/core instead of the deprecated rspress package. This aligns with Rspress V2's package consolidation where multiple packages were merged into a single @rspress/core package.

Changes:

  • Updated the installation command in the getting started documentation from rspress to @rspress/core for both English and Chinese versions

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
website/docs/zh/guide/start/getting-started.mdx Updated installation command to use @rspress/core in Chinese documentation
website/docs/en/guide/start/getting-started.mdx Updated installation command to use @rspress/core in English documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 4, 2026

Rsdoctor Bundle Diff Analysis

Found 3 projects in monorepo, 3 projects with changes.

📊 Quick Summary
Project Total Size Change
node 11.9 MB +58.0 B (0.0%)
node_md 1.5 MB +120.0 B (0.0%)
web 15.8 MB +10.0 B (0.0%)
📋 Detailed Reports (Click to expand)

📁 node

Path: website/doc_build/diff-rsdoctor/node/rsdoctor-data.json

📌 Baseline Commit: eea4cf66eb | PR: #3103

Metric Current Baseline Change
📊 Total Size 11.9 MB 11.9 MB +58.0 B (0.0%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 11.9 MB 11.9 MB +58.0 B (0.0%)
📁 Other Assets 0 B 0 B 0

📦 Download Diff Report: node Bundle Diff

📁 node_md

Path: website/doc_build/diff-rsdoctor/node_md/rsdoctor-data.json

📌 Baseline Commit: eea4cf66eb | PR: #3103

Metric Current Baseline Change
📊 Total Size 1.5 MB 1.5 MB +120.0 B (0.0%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 1.5 MB 1.5 MB +120.0 B (0.0%)

📦 Download Diff Report: node_md Bundle Diff

📁 web

Path: website/doc_build/diff-rsdoctor/web/rsdoctor-data.json

📌 Baseline Commit: eea4cf66eb | PR: #3103

Metric Current Baseline Change
📊 Total Size 15.8 MB 15.8 MB +10.0 B (0.0%)
📄 JavaScript 15.5 MB 15.5 MB +10.0 B (0.0%)
🎨 CSS 119.3 KB 119.3 KB 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 166.3 KB 166.3 KB 0

📦 Download Diff Report: web Bundle Diff

Generated by Rsdoctor GitHub Action

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Feb 4, 2026

Deploying rspress-v2 with  Cloudflare Pages  Cloudflare Pages

Latest commit: d58afec
Status: ✅  Deploy successful!
Preview URL: https://a4f8e0c4.rspress-v2.pages.dev
Branch Preview URL: https://syt-vibe-kanban-eaaf-npm-ins.rspress-v2.pages.dev

View logs

@SoonIter SoonIter requested a review from Timeless0911 February 4, 2026 03:28
@SoonIter SoonIter merged commit 24e2b93 into main Feb 4, 2026
13 checks passed
@SoonIter SoonIter deleted the syt-vibe-kanban/eaaf-npm-install-rspr branch February 4, 2026 03:44
@SoonIter SoonIter mentioned this pull request Feb 4, 2026
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@Timeless0911 Timeless0911 Timeless0911 approved these changes

Assignees

No one assigned

Labels

change: docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@SoonIter @Timeless0911