-
-
Notifications
You must be signed in to change notification settings - Fork 239
docs: improve documentation for file size diff #6717
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
There was a problem hiding this 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 pull request improves the documentation for the printFileSize.diff configuration option by providing more detailed explanations and examples across English and Chinese documentation files, as well as updating the TypeScript JSDoc comments.
Key Changes:
- Enhanced explanation of how the diff feature works (snapshot recording and comparison)
- Added comprehensive examples showing the output format with size deltas
- Improved clarity of when the diff information becomes available (starting from second build)
- Added version history section documenting the feature's introduction in v1.6.13
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| website/docs/en/config/performance/print-file-size.mdx | Updated English documentation with clearer descriptions and examples for the diff option, including output format and snapshot storage details |
| website/docs/zh/config/performance/print-file-size.mdx | Added complete Chinese documentation for the diff option with translated content matching the English version structure |
| packages/core/src/types/config.ts | Enhanced JSDoc comment for the diff property with more detailed explanation of the snapshot mechanism |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Summary
Update the documentation for the
printFileSize.diffoption to provide clearer explanations and examples:Checklist