Skip to content

Docs: Clarify Storybook Initializer Packages#35014

Open
miachillgood wants to merge 1 commit into
storybookjs:nextfrom
miachillgood:codex/clarify-install-dependencies
Open

Docs: Clarify Storybook Initializer Packages#35014
miachillgood wants to merge 1 commit into
storybookjs:nextfrom
miachillgood:codex/clarify-install-dependencies

Conversation

@miachillgood

@miachillgood miachillgood commented Jun 1, 2026

Copy link
Copy Markdown

Summary

  • Clarify that the Storybook initializer updates package.json with the storybook package, the project framework package, selected addons, and run/build scripts.
  • Note that typical projects do not need to manually add @storybook/cli.

Fixes #20030.

Validation

  • git diff --check

Manual testing

Documentation-only change. I reviewed the rendered MDX source and confirmed the new callout appears in the install flow after the initializer change list.

@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor
Fails
🚫

PR is not labeled with one of: ["ci:normal","ci:merged","ci:daily","ci:docs"]

Generated by 🚫 dangerJS against 3eed23e

@coderabbitai

coderabbitai Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a3e1f462-db2f-4269-b22f-6f8be5158124

📥 Commits

Reviewing files that changed from the base of the PR and between c4f53de and 3eed23e.

📒 Files selected for processing (1)
  • docs/get-started/install.mdx

📝 Walkthrough

Walkthrough

Added an informational callout to the install documentation explaining what the Storybook initializer does: updating package.json with the storybook package, framework-specific package, selected addons, and run/build scripts, while noting that @storybook/cli is typically not manually added.

Changes

Installer Documentation Update

Layer / File(s) Summary
Initializer behavior callout
docs/get-started/install.mdx
Info callout added describing how the Storybook initializer modifies package.json by adding the storybook package, framework package (e.g., @storybook/react-vite, @storybook/nextjs), selected addons, and run/build scripts, while clarifying that @storybook/cli is typically not manually installed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@miachillgood miachillgood changed the title Clarify packages installed by the Storybook initializer Docs: Clarify Storybook Initializer Packages Jun 1, 2026
@miachillgood

Copy link
Copy Markdown
Author

Hi maintainers, thanks for taking a look. Could you please add the appropriate labels when you get a chance? I believe this should be documentation and ci:docs, since this is a docs-only change. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Empathy Queue (prioritized)

Development

Successfully merging this pull request may close these issues.

[Bug]: Documentation does not make clear which storybook packages must be installed

2 participants