Core: Add changeDetection feature flag#34314
Conversation
|
View your CI Pipeline Execution ↗ for commit 7f4b44e
☁️ Nx Cloud last updated this comment at |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds a new optional Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
✨ Finishing Touches📝 Generate docstrings
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/api/main-config/main-config-features.mdx (1)
141-148: Consider expanding the documentation description.The description "Enable change detection." is quite vague. Users would benefit from understanding:
- What behavior this feature flag controls
- Which renderers/frameworks it affects
- Why they might want to enable or disable it
Other feature flags in this file include links to more detailed documentation (e.g.,
[Actions](../../essentials/actions.mdx)). Consider adding similar context or a brief explanation of what "change detection" means in this context.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/api/main-config/main-config-features.mdx` around lines 141 - 148, The `changeDetection` entry has an overly terse description; update it to explain what behavior the flag controls (e.g., whether the system performs automatic diffing to detect and apply UI/state changes vs. requiring manual updates), list which renderers/frameworks it affects (mention any specific renderers or integrations that honor this flag), and give guidance on when to enable vs. disable it (performance tradeoffs, debugging, or manual-control scenarios). Replace "Enable change detection." with a short sentence covering those points and add a link to the detailed docs or a relevant section (same style as other flags) for users who need deeper information.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/api/main-config/main-config-features.mdx`:
- Around line 141-148: The `changeDetection` entry has an overly terse
description; update it to explain what behavior the flag controls (e.g., whether
the system performs automatic diffing to detect and apply UI/state changes vs.
requiring manual updates), list which renderers/frameworks it affects (mention
any specific renderers or integrations that honor this flag), and give guidance
on when to enable vs. disable it (performance tradeoffs, debugging, or
manual-control scenarios). Replace "Enable change detection." with a short
sentence covering those points and add a link to the detailed docs or a relevant
section (same style as other flags) for users who need deeper information.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 3b795c7a-973a-4f71-8827-5664668c7a6a
📒 Files selected for processing (3)
code/core/src/core-server/presets/common-preset.tscode/core/src/types/modules/core-common.tsdocs/api/main-config/main-config-features.mdx
Closes #
What I did
Added
changeDetectionfeature flagChecklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
Caution
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>Summary by CodeRabbit
New Features
Documentation