Skip to content

docs(website-new): refactor experiments page for clarity, consistency #3783

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

Merged
merged 1 commit into from
May 16, 2025

Conversation

ScriptedAlchemy
Copy link
Member

This pull request updates the documentation for the experiments configuration in the apps/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 the disableSnapshot flag, and introducing a new table to illustrate the impact of optimization flags on remoteEntry.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) for asyncStartup, externalRuntime, provideExternalRuntime, disableSnapshot, and target. This improves readability and consistency across the documentation. [1] [2] [3]

Additional Warnings:

  • Added a cautionary note under the disableSnapshot option, warning users about the potential loss of TypeScript syncing support and hot module replacement (HMR) when this flag is enabled.

Optimization Guidance:

  • Introduced a new section with a table showing how different combinations of the disableSnapshot, target: 'web', and externalRuntime flags affect the size of the remoteEntry.js file. This helps users understand the trade-offs between runtime features and bundle size.

Copy link

netlify bot commented May 16, 2025

Deploy Preview for module-federation-docs ready!

Name Link
🔨 Latest commit 0b9329e
🔍 Latest deploy log https://app.netlify.com/projects/module-federation-docs/deploys/6826e5865169980008e06178
😎 Deploy Preview https://deploy-preview-3783--module-federation-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

changeset-bot bot commented May 16, 2025

⚠️ No Changeset found

Latest commit: 0b9329e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ScriptedAlchemy ScriptedAlchemy merged commit 1e24dc3 into main May 16, 2025
8 of 9 checks passed
@ScriptedAlchemy ScriptedAlchemy deleted the docs/experiments-optimization-size-warnings branch May 16, 2025 07:14
@KyrieLii KyrieLii mentioned this pull request May 27, 2025
mitchellrj pushed a commit to mitchellrj/module-federation-core that referenced this pull request May 27, 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