docs: clarify custom message handling#7048
Conversation
Summary of ChangesHello @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 improving the clarity and detail of the documentation related to custom message handling within the Rsbuild development server API. The changes provide a more precise understanding of how to send custom messages using the Highlights
Using Gemini Code AssistThe 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
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 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
|
Deploying rsbuild with
|
| Latest commit: |
b927b69
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://aa0dbefe.rsbuild-v2.pages.dev |
| Branch Preview URL: | https://custom-msg-doc-0126.rsbuild-v2.pages.dev |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request provides a helpful clarification to the documentation on custom message handling for the dev server API. The changes in both the English and Chinese documents explain that Rsbuild extends the on() method of import.meta.webpackHot, which is a valuable piece of information for users. The addition of via custom type and the consistency fix for code block titles in the Chinese document are also good improvements. Overall, these changes make the documentation clearer and more accurate. Well done.
There was a problem hiding this comment.
Pull request overview
This PR improves the documentation for custom message handling in the dev server API by clarifying that Rsbuild extends Rspack's native HMR API.
Changes:
- Enhanced explanation that Rsbuild extends the
on()method on Rspack'simport.meta.webpackHotobject - Added reference link to Rspack's HMR documentation
- Added descriptive titles to code blocks for better context
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/docs/en/api/javascript-api/dev-server-api.mdx | Updated English documentation to clarify custom message handling with improved descriptions and code block titles |
| website/docs/zh/api/javascript-api/dev-server-api.mdx | Updated Chinese documentation to match English version with equivalent clarifications and improvements |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
1 participant
Summary
Expanded the explanation that Rsbuild extends the
on()method on Rspack’simport.meta.webpackHot.Checklist