docs: add detailed JSDoc to manifest data types #6632
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive JSDoc documentation to the ManifestByEntry and ManifestData TypeScript types to improve code clarity and developer experience.
Key Changes
- Detailed JSDoc comments added to all properties in ManifestByEntry and ManifestData types
- Moved
allFilesproperty beforeentriesin both type definitions and documentation for better logical ordering - Updated both English and Chinese documentation to match the enhanced type definitions
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/core/src/types/config.ts | Added JSDoc comments to ManifestByEntry and ManifestData types, reordered properties for clarity |
| website/docs/en/config/output/manifest.mdx | Updated English documentation to reflect enhanced type definitions with detailed comments |
| website/docs/zh/config/output/manifest.mdx | Updated Chinese documentation to reflect enhanced type definitions with detailed comments |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| /** other assets (e.g., png, svg, source map) related to the current entry */ | ||
| /** | ||
| * Additional assets associated with this entry. | ||
| * For example images、fonts、source maps and other non JS or CSS files. |
There was a problem hiding this comment.
Missing comma after "images" in the list. The text should be "For example images, fonts, source maps and other non JS or CSS files." with proper punctuation.
| * For example images、fonts、source maps and other non JS or CSS files. | |
| * For example images, fonts, source maps and other non JS or CSS files. |
| html?: string[]; | ||
| /** | ||
| * Additional assets associated with this entry. | ||
| * For example images、fonts、source maps and other non JS or CSS files. |
There was a problem hiding this comment.
Missing comma after "images" in the list. The text should be "For example images, fonts, source maps and other non JS or CSS files." with proper punctuation.
| * For example images、fonts、source maps and other non JS or CSS files. | |
| * For example, images, fonts, source maps and other non JS or CSS files. |
Summary
Add detailed JSDoc to ManifestByEntry and ManifestData types to clarify the purpose and structure of each property.
Checklist