-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
Docs: Update CLI reference, add nextjs-vite guide
#32903
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
Conversation
…ate Next.js (Webpack) section to recommend Vite migration
…loglevel` and `--write-logs` for improved debugging and log management.
…cts, including descriptions for "React Native", "React Native Web", and "Both" options, along with installation instructions for each environment.
…uding automatic and manual configuration instructions for running accessibility tests alongside component tests in Storybook.
…fy Next.js framework requirements, and enhance instructions for installing Playwright browser binaries.
…iling onboarding features and configuration options for recommended and minimal setups.
|
View your CI Pipeline Execution ↗ for commit 5c0ba1a
☁️ Nx Cloud last updated this comment at |
📝 WalkthroughWalkthroughThis PR updates documentation across multiple files to support new CLI options (--loglevel and --write-logs), clarify Next.js framework options (Webpack vs Vite), add comprehensive Next.js+Vite framework documentation, expand Vitest addon setup guidance, and document automigration pathways. No code changes or public API modifications were made. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Comment |
shilman
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Added a few small comments.
| - **"Both"**: Add both native and web Storybooks | ||
| - Installs and configures both environments | ||
| - Allows you to run Storybook for both native and web in the same project | ||
| - Best for projects that want both native fidelity and web features |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm out of my depth with RN but should we explain to users how they can choose between native and web if choosing the "both" option?
Does it mean they select which stories render in what mode? or must stories work in both native and web?
Rationale : If a user who knows they want to avoid a perf/rendering issue on "native" or "web" with specific components, they need to know about fine-grained control to decide if "both" is right for them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@shilman ?
Co-authored-by: Steve Dodier-Lazaro <[email protected]>
kylegach
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work, @valentinpalkovic!
nextjs-vite guide
Closes #
What I did
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
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
Documentation
--logleveland--write-logsparameters