Skip to content

Conversation

@Sidnioulz
Copy link
Member

@Sidnioulz Sidnioulz commented Dec 10, 2025

Adds a copy event to the second create command on the install page.

@shilman note that there is still an issue with the deployment. The first create command on the page was correctly updated in the codebase but is not updated in the website.

Summary by CodeRabbit

  • Documentation
    • Enhanced installation guides with improved code snippet display and formatting options
    • Clarified installation instructions for Storybook 8.3 and newer versions with refined guidance

✏️ Tip: You can customize this high-level summary in your review settings.

@Sidnioulz Sidnioulz requested a review from shilman December 10, 2025 13:23
@Sidnioulz Sidnioulz added documentation ci:docs Run the CI jobs for documentation checks only. labels Dec 10, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 10, 2025

📝 Walkthrough

Walkthrough

Updates documentation in install.mdx by adding variant="new-users" and copyEvent="CreateCommandCopy" props to the CodeSnippets component, and revises installation guidance text wording.

Changes

Cohort / File(s) Change Summary
Documentation snippet enhancement
docs/get-started/install.mdx
Added variant="new-users" and copyEvent="CreateCommandCopy" props to CodeSnippets component; revised guidance text from "For installing" to "To install"

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Single file modification with straightforward component prop additions and minor text wording adjustment

Possibly related PRs


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6127326 and c79e8f4.

📒 Files selected for processing (1)
  • docs/get-started/install.mdx (1 hunks)
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Applies to code/{addons,frameworks}/**/README.md : Include code examples in addon/framework documentation for significant changes
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Applies to README.md : Update relevant README files for significant code changes
📚 Learning: 2025-11-28T14:50:24.889Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Applies to README.md : Update relevant README files for significant code changes

Applied to files:

  • docs/get-started/install.mdx
📚 Learning: 2025-11-05T09:38:47.712Z
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/components/components/Select/Select.tsx:200-204
Timestamp: 2025-11-05T09:38:47.712Z
Learning: Repo: storybookjs/storybook — Guidance: Until Storybook 11 is released, do not suggest using React.useId anywhere (e.g., in code/core/src/components/components/Select/Select.tsx) to maintain compatibility with React 17 runtimes. Prefer advising: accept a caller-provided props.id and, if needed, generate a client-only fallback id to minimize SSR hydration issues — but avoid useId. Resume prompting for useId after Storybook 11.

Applied to files:

  • docs/get-started/install.mdx
📚 Learning: 2025-11-28T14:50:24.889Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Applies to code/{addons,frameworks}/**/README.md : Include code examples in addon/framework documentation for significant changes

Applied to files:

  • docs/get-started/install.mdx
📚 Learning: 2025-11-28T14:50:24.889Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Follow existing patterns and conventions in the Storybook codebase

Applied to files:

  • docs/get-started/install.mdx
📚 Learning: 2025-10-02T09:22:13.215Z
Learnt from: JReinhold
Repo: storybookjs/storybook PR: 32607
File: code/package.json:243-243
Timestamp: 2025-10-02T09:22:13.215Z
Learning: The Storybook repository uses Yarn v^4 (any 4.x version) as the package manager, configured via .yarnrc.yml and package.json packageManager field. Specific patch versions within v4 can be upgraded as needed.

Applied to files:

  • docs/get-started/install.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Core Unit Tests, windows-latest
🔇 Additional comments (2)
docs/get-started/install.mdx (2)

67-67: Text rewording improves clarity.

The change from "For installing Storybook 8.3 or newer" to "To install Storybook 8.3 or newer" is a minor but valuable improvement. The revised phrasing is more direct and conversational, aligning with the tone of the document.


10-10: No action needed — CodeSnippets component already supports variant and copyEvent props.

The props being added (variant="new-users" and copyEvent="CreateCommandCopy") are already widely supported and used consistently throughout the documentation codebase, including in docs/index.mdx, docs/releases/migration-guide.mdx, and multiple framework-specific files in docs/get-started/frameworks/. Both instances in install.mdx (lines 10 and 62) have identical props, which is intentional and aligns with the existing pattern across all similar code snippet references.


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

@valentinpalkovic valentinpalkovic merged commit d15032f into next Dec 10, 2025
19 of 21 checks passed
@valentinpalkovic valentinpalkovic deleted the sidnioulz/instrument-more-create-commands branch December 10, 2025 19:56
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. documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants