Skip to content

docs: update JavaScript runtime installation instructions#5787

Merged
chenjiahan merged 4 commits intomainfrom
install_runtime_docs_0807
Aug 7, 2025
Merged

docs: update JavaScript runtime installation instructions#5787
chenjiahan merged 4 commits intomainfrom
install_runtime_docs_0807

Conversation

@chenjiahan
Copy link
Copy Markdown
Member

@chenjiahan chenjiahan commented Aug 7, 2025

Summary

As Rsbuild ≥ 1.5.0 no longer supports Node 16, the quick start guide should be updated to reflect this.

This PR also adds links to the installation guides for other JavaScript runtimes, such as Bun and Deno.

I removed the previous detailed Node.js installation guide because the Node.js website now provides better instructions: https://nodejs.org/en/download.

Related Links

Checklist

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

Copilot AI review requested due to automatic review settings August 7, 2025 07:23
@netlify
Copy link
Copy Markdown

netlify bot commented Aug 7, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit c2ff485
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/689458c75f12e00008e131b7
😎 Deploy Preview https://deploy-preview-5787--rsbuild.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 75 (🔴 down 7 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

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 PR updates the JavaScript runtime installation instructions to reflect that Rsbuild ≥ 1.5.0 no longer supports Node.js 16. The documentation is simplified to provide links to installation guides for all supported runtimes (Node.js, Bun, and Deno) rather than detailed Node.js-specific instructions.

  • Clarifies version requirements for different Rsbuild versions
  • Adds installation links for Bun and Deno alongside Node.js
  • Simplifies contributing documentation by removing detailed Node.js installation steps

Reviewed Changes

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

File Description
website/docs/zh/guide/start/quick-start.mdx Updates Chinese quick start guide with simplified runtime installation instructions and version requirements
website/docs/en/guide/start/quick-start.mdx Updates English quick start guide with simplified runtime installation instructions and version requirements
CONTRIBUTING.md Simplifies Node.js installation section by replacing detailed instructions with a link

@chenjiahan chenjiahan merged commit 6cf3ceb into main Aug 7, 2025
11 checks passed
@chenjiahan chenjiahan deleted the install_runtime_docs_0807 branch August 7, 2025 07:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants