Skip to content

docs: update README with simplified badges and content#20

Merged
chenjiahan merged 4 commits intomainfrom
update_readme_0314
Mar 15, 2026
Merged

docs: update README with simplified badges and content#20
chenjiahan merged 4 commits intomainfrom
update_readme_0314

Conversation

@chenjiahan
Copy link
Member

  • Replace old badge format with simplified shields.io badges
  • Remove redundant support section and outdated webpack references
  • Update configuration examples to use rspack.config.js consistently
  • Clean up and streamline the overall documentation

Copilot AI review requested due to automatic review settings March 14, 2026 14:04
@gemini-code-assist
Copy link

Summary of Changes

Hello, 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 significantly refactors the README.md file to enhance its clarity, accuracy, and alignment with the Rspack ecosystem. The changes aim to provide a more focused and up-to-date guide for users of @rspack/dev-middleware, removing obsolete information and modernizing presentation elements.

Highlights

  • Documentation Modernization: Replaced outdated badge formats with simplified shields.io badges for a cleaner and more consistent look.
  • Content Streamlining: Removed redundant support sections and references to outdated webpack concepts to focus on Rspack.
  • Configuration Consistency: Updated all configuration examples to consistently use rspack.config.js, aligning with Rspack's ecosystem.
  • Overall Clarity: Cleaned up and streamlined the entire README.md to improve readability and relevance.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • README.md
    • Updated repository badges to a modern shields.io format and removed the old webpack logo.
    • Simplified the 'Getting Started' installation instruction.
    • Removed the warning about not installing the module globally.
    • Eliminated the entire 'Support' section.
    • Replaced all instances of webpack.config.js with rspack.config.js in code examples.
    • Removed unused badge definition links from the end of the file.
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

@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 does a great job of updating and streamlining the README.md file by simplifying badges and removing outdated content. However, in the process of updating the configuration examples to use rspack.config.js, a few copy-paste errors were introduced. In several examples, the variable holding the configuration was renamed, but the old variable name is still being used when calling rspack(). I've left comments on each occurrence with a suggested fix.

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 49ed39ca8c

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Copy link

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 for @rspack/dev-middleware by replacing old webpack-style badges with simplified shields.io badges, removing outdated webpack references and the support section, and renaming config file references from webpack.config.js to rspack.config.js.

Changes:

  • Replaced old badge format with inline shields.io badges and removed trailing link references
  • Removed the "Support" section and global install warning
  • Renamed webpack.config.jsrspack.config.js in server examples

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

@chenjiahan chenjiahan merged commit 651ef41 into main Mar 15, 2026
5 checks passed
@chenjiahan chenjiahan deleted the update_readme_0314 branch March 15, 2026 01:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants