docs(website-new): refactor experiments page for clarity, consistency #3783
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.
This pull request updates the documentation for the
experiments
configuration in theapps/website-new/docs/en/configure/experiments.mdx
file to provide clearer descriptions, additional warnings, and examples of how optimization flags impact bundle size. The most important changes include standardizing the formatting of configuration options, adding a warning about thedisableSnapshot
flag, and introducing a new table to illustrate the impact of optimization flags onremoteEntry.js
size.Documentation Improvements:
Updated the description of the
experiments
configuration to clarify its purpose as enabling advanced and experimental capabilities in the plugin.Standardized the formatting of configuration option details (e.g.,
Type
,Required
,Default
) forasyncStartup
,externalRuntime
,provideExternalRuntime
,disableSnapshot
, andtarget
. This improves readability and consistency across the documentation. [1] [2] [3]Additional Warnings:
disableSnapshot
option, warning users about the potential loss of TypeScript syncing support and hot module replacement (HMR) when this flag is enabled.Optimization Guidance:
disableSnapshot
,target: 'web'
, andexternalRuntime
flags affect the size of theremoteEntry.js
file. This helps users understand the trade-offs between runtime features and bundle size.