Skip to content

Conversation

@valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Oct 31, 2025

Closes #

What I did

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make 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/core team 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

  • Added CLI option documentation for --loglevel and --write-logs parameters
  • Published comprehensive Next.js with Vite framework guide covering setup, features, and configuration
  • Updated Next.js Webpack framework documentation with migration guidance to Vite
  • Enhanced installation prompts and interactive onboarding workflow documentation
  • Expanded Vitest addon testing integration, including accessibility testing and manual setup options
  • Added Next.js to Next.js Vite automigration reference guide

…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.
@nx-cloud
Copy link

nx-cloud bot commented Oct 31, 2025

View your CI Pipeline Execution ↗ for commit 5c0ba1a

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 45s View ↗

☁️ Nx Cloud last updated this comment at 2025-11-19 18:32:51 UTC

@shilman shilman added documentation cli ci:docs Run the CI jobs for documentation checks only. labels Nov 3, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 3, 2025

Caution

Review failed

The head commit changed during the review from e433064 to 9d02deb.

📝 Walkthrough

Walkthrough

This 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

Cohort / File(s) Summary
CLI options documentation
docs/api/cli-options.mdx
Added --loglevel and --write-logs CLI options documentation across init, add, remove, and create-storybook commands; reworded --features values with trailing comma formatting
Next.js framework documentation
docs/get-started/frameworks/nextjs-vite.mdx
New comprehensive page documenting Next.js+Vite framework setup, including requirements, getting started flows, Image/font support, routing, mocking, RSC support, and API details
Next.js framework documentation
docs/get-started/frameworks/nextjs.mdx
Updated existing documentation to clarify Webpack-based approach; added callout recommending Vite-based framework; revised onboarding guidance and migration paths
Installation & onboarding documentation
docs/get-started/install.mdx, docs/get-started/frameworks/react-native-web-vite.mdx
Added "Installation prompts" section detailing interactive onboarding and configuration options; expanded React Native/React Native Web setup prompts with detailed installation steps
Testing integrations documentation
docs/writing-tests/accessibility-testing.mdx, docs/writing-tests/integrations/vitest-addon.mdx
Added Vitest addon integration section to accessibility testing docs; significantly expanded Vitest addon documentation with detailed setup flows, explicit steps, manual configuration guidance, and enhanced Next.js/Playwright instructions
Migration documentation
docs/releases/upgrading.mdx
Added documentation block describing Next.js to Next.js Vite automigration process, including what changes and manual execution steps

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Review accuracy of CLI option descriptions and command coverage
  • Verify consistency between new Next.js Vite framework documentation and existing Webpack framework documentation
  • Ensure Vitest addon setup flows and manual configuration steps align with actual addon behavior
  • Validate automigration documentation accurately describes the process and tool behavior
  • Check for duplicate/redundant content in install.mdx and upgrading.mdx where content appears in multiple locations

Possibly related PRs


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Member

@shilman shilman left a 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.

Comment on lines +44 to +47
- **"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
Copy link
Member

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, @valentinpalkovic!

Base automatically changed from valentin/cli-init-rework to next November 19, 2025 13:03
@kylegach kylegach changed the title Valentin/cli init docs Docs: Update CLI reference, add nextjs-vite guide Nov 19, 2025
@valentinpalkovic valentinpalkovic merged commit af5666f into next Nov 19, 2025
13 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/cli-init-docs branch November 19, 2025 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. cli documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants