added a more detailed example for tree-shaking clarification #7593
+218
−0
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.
Enhance Tree Shaking Documentation with Full Example
This PR enhances the tree shaking documentation by adding a comprehensive section that explains side effects in more detail with a practical example.
Fixes: #7414
Changes
Added a new section "Full Example: Understanding Side Effects with CSS Files" that demonstrates:
Added a "Common Pitfalls with Side Effects" section covering:
sideEffects: false
Rationale
The existing documentation uses the Shopify Polaris example but doesn't provide enough context about the full structure of the files, making it challenging for readers to understand the practical implications of the
sideEffects
flag.This enhancement gives readers a more concrete example that shows the direct impact of incorrect side effects configuration (particularly for CSS files) and provides guidance on how to diagnose and fix these issues.