docs: enhance content.devServer type
#6830
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the documentation for the context.devServer type by adding inline JSDoc comments to the hostname, port, and https fields, and improves code formatting in example sections.
Key changes:
- Added JSDoc comments to
DevServertype properties in both English and Chinese documentation - Updated the source TypeScript type definition to clarify that
portis the "actual" port number - Improved code formatting by moving inline comments to separate lines for better readability
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
website/docs/zh/api/javascript-api/instance.mdx |
Added Chinese JSDoc comments for DevServer type properties and reformatted example code |
website/docs/en/api/javascript-api/instance.mdx |
Added English JSDoc comments for DevServer type properties and reformatted example code |
website/docs/en/api/javascript-api/dev-server-api.mdx |
Reformatted multi-line comment for better readability |
packages/core/src/types/context.ts |
Updated port comment to clarify it's the "actual" port number |
packages/core/src/server/devServer.ts |
Reformatted multi-line comment for better readability |
After thorough review of all changes, I found no issues with the code. The changes are well-executed:
- Documentation consistency: The English and Chinese documentation are properly synchronized
- Comment quality: All new comments are clear, accurate, and grammatically correct
- Code formatting: The reformatting of inline comments to separate lines improves readability
- Type accuracy: The clarification that
portrefers to the "actual" port number is helpful and accurate
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added and clarified comments for the
hostname,port, andhttpsfields forcontext.devServer.Checklist