Skip to content

docs: add client.overlay configuration details#6804

Merged
chenjiahan merged 1 commit intomainfrom
overlay_doc_1218
Dec 18, 2025
Merged

docs: add client.overlay configuration details#6804
chenjiahan merged 1 commit intomainfrom
overlay_doc_1218

Conversation

@chenjiahan
Copy link
Copy Markdown
Member

Summary

Updates the documentation for the dev.client.overlay configuration option, adds the type and default value for this option to make the documentation more complete

Checklist

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

Copilot AI review requested due to automatic review settings December 18, 2025 08:10
@netlify
Copy link
Copy Markdown

netlify bot commented Dec 18, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 383f21f
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/6943b6edb316610008e4982a
😎 Deploy Preview https://deploy-preview-6804--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: 70 (🔴 down 2 from production)
Accessibility: 100 (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
Copy Markdown
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 enhances the documentation for the dev.client.overlay configuration option by adding explicit type and default value information, making the documentation more consistent with other configuration options in the same file.

Key changes:

  • Added type (boolean) and default value (true) documentation for the overlay option
  • Applied changes to both English and Chinese documentation files

Reviewed changes

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

File Description
website/docs/en/config/dev/client.mdx Added type and default value documentation for overlay option in English
website/docs/zh/config/dev/client.mdx Added type and default value documentation for overlay option in Chinese

The documentation changes look good. The added type and default value information is consistent with the formatting used for other configuration options (like logLevel and reconnect) in the same files. Both English and Chinese versions are properly updated with matching information. No issues were identified.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@chenjiahan chenjiahan merged commit c6ef82f into main Dec 18, 2025
18 checks passed
@chenjiahan chenjiahan deleted the overlay_doc_1218 branch December 18, 2025 08:12
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.

2 participants