Skip to content

Comments

docs: add Rsbuild v2 documentation links#7152

Merged
chenjiahan merged 1 commit intomainfrom
readme_v2_link_0205
Feb 5, 2026
Merged

docs: add Rsbuild v2 documentation links#7152
chenjiahan merged 1 commit intomainfrom
readme_v2_link_0205

Conversation

@chenjiahan
Copy link
Member

Summary

Removed the performance benchmark section and provide direct links to Rsbuild v1 and v2 documentation in each language.

Checklist

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

Copilot AI review requested due to automatic review settings February 5, 2026 09:44
@chatgpt-codex-connector
Copy link

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @chenjiahan, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on refining the project's README files by removing the performance benchmark section and enhancing the documentation links. The primary goal is to offer clearer and more direct navigation for users seeking information on specific Rsbuild versions (v1 or v2) across the English, Portuguese, and Chinese language documentation.

Highlights

  • Documentation Structure: The performance benchmark section has been removed from all README files (English, Portuguese, and Chinese versions) to streamline the documentation.
  • Documentation Links: The 'Getting started' sections across all README files have been updated and renamed to 'Documentation', now providing direct links to both Rsbuild v1 and v2 documentation.
Changelog
  • README.md
    • Removed the '🚀 Performance' section, including its descriptive text and benchmark image.
    • Changed the heading '📚 Getting started' to '📚 Documentation'.
    • Replaced the single 'Quick start' link with separate links for 'Rsbuild v2 docs' and 'Rsbuild v1 docs'.
  • README.pt-BR.md
    • Removed the '🚀 Desempenho' (Performance) section, including its descriptive text and benchmark image.
    • Changed the heading '📚 Primeiros passos' (Getting started) to '📚 Documentação' (Documentation).
    • Replaced the single 'Início Rápido' (Quick start) link with separate links for 'Rsbuild v2 docs' and 'Rsbuild v1 docs'.
  • README.zh-CN.md
    • Removed the '🚀 性能' (Performance) section, including its descriptive text and benchmark image.
    • Changed the heading '📚 快速上手' (Getting started) to '📚 文档' (Documentation).
    • Replaced the single '快速上手' (Quick start) link with separate links for 'Rsbuild v2 文档' and 'Rsbuild v1 文档'.
Activity
  • No specific activity (comments, reviews, or progress updates) has been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README files in English, Portuguese, and Chinese. It removes the performance benchmark section and replaces the 'Getting Started' section with a 'Documentation' section that links directly to the Rsbuild v1 and v2 documentation. The changes are clear and align with the goal of improving documentation access. I've suggested a minor improvement for the Portuguese README to translate the link text for consistency.

Copy link
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 README documentation across three language versions (English, Chinese, and Portuguese) by removing the outdated performance benchmark section and adding direct links to both Rsbuild v2 and v1 documentation.

Changes:

  • Removed the "Performance" section containing benchmark data and graphs from all three README files
  • Changed the "Getting started" section to "Documentation" section
  • Added direct links to both Rsbuild v2 and v1 documentation sites in each language version

Reviewed changes

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

File Description
README.md Removed performance benchmark section and replaced "Getting started" with "Documentation" section containing links to v2 and v1 docs
README.zh-CN.md Same changes as English version, with Chinese-localized documentation links (using /zh/ paths)
README.pt-BR.md Same changes as English version, linking to English docs (Portuguese localization not available)

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

@chenjiahan chenjiahan merged commit c265916 into main Feb 5, 2026
12 checks passed
@chenjiahan chenjiahan deleted the readme_v2_link_0205 branch February 5, 2026 13:32
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.

1 participant