Skip to content

docs: improve script loading documentation clarity#6357

Merged
chenjiahan merged 1 commit intomainfrom
script_loading_1014
Oct 14, 2025
Merged

docs: improve script loading documentation clarity#6357
chenjiahan merged 1 commit intomainfrom
script_loading_1014

Conversation

@chenjiahan
Copy link
Member

Summary

  • Update JSDoc and documentation to better explain html.scriptLoading behavior
  • Add MDN links and reorganize content for better readability

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copilot AI review requested due to automatic review settings October 14, 2025 13:11
@netlify
Copy link

netlify bot commented Oct 14, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit c84ce79
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/68ee4c0336bb69000862157a
😎 Deploy Preview https://deploy-preview-6357--rsbuild.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 73 (🟢 up 4 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

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 improves the documentation clarity for the html.scriptLoading configuration option by reorganizing content, adding detailed explanations for each loading mode, including MDN links, and updating JSDoc comments.

  • Enhanced documentation with clearer descriptions of each script loading mode (defer, module, blocking)
  • Added MDN reference links and reorganized sections for better readability
  • Updated JSDoc comments to match the improved documentation style

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
website/docs/zh/config/html/script-loading.mdx Chinese documentation improvements with reorganized sections and enhanced descriptions
website/docs/en/config/html/script-loading.mdx English documentation improvements with reorganized sections and enhanced descriptions
packages/core/src/types/config.ts Updated JSDoc comments to provide clearer explanations of script loading modes

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@chenjiahan chenjiahan merged commit 6d2b9fa into main Oct 14, 2025
12 checks passed
@chenjiahan chenjiahan deleted the script_loading_1014 branch October 14, 2025 13:21
@chenjiahan chenjiahan mentioned this pull request Oct 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant