Skip to content

Conversation

@Sidnioulz
Copy link
Member

@Sidnioulz Sidnioulz commented Dec 3, 2025

What I did

Goes with storybookjs/web#363

  • Added missing new-users variant in /docs/get-started/install page snippet
  • Added custom event id for all code snippets for the create command

Checklist for Contributors

Testing

ø

Documentation

ø

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 copy-event support to code snippets across the get-started and migration guides, enabling consistent copy interaction tracking for installation and framework examples (Angular, Next.js, React, Vue, Svelte, Preact, Web Components, React Native Web, and related docs).

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

@Sidnioulz Sidnioulz requested a review from shilman December 3, 2025 16:16
@Sidnioulz Sidnioulz added maintenance User-facing maintenance tasks ci:docs Run the CI jobs for documentation checks only. experiment This issue/PR is an experiment; it doesn't always follow production standards but will be monitored. labels Dec 3, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 3, 2025

📝 Walkthrough

Walkthrough

Adds a copyEvent="CreateCommandCopy" prop to CodeSnippets component usages across multiple documentation MDX files, updating snippet invocations to include an event identifier for copy actions.

Changes

Cohort / File(s) Summary
Framework documentation updates
docs/get-started/frameworks/angular.mdx, docs/get-started/frameworks/nextjs-vite.mdx, docs/get-started/frameworks/nextjs.mdx, docs/get-started/frameworks/preact-vite.mdx, docs/get-started/frameworks/react-native-web-vite.mdx, docs/get-started/frameworks/react-vite.mdx, docs/get-started/frameworks/react-webpack5.mdx, docs/get-started/frameworks/svelte-vite.mdx, docs/get-started/frameworks/sveltekit.mdx, docs/get-started/frameworks/vue3-vite.mdx, docs/get-started/frameworks/web-components-vite.mdx
Updated CodeSnippets invocations to include copyEvent="CreateCommandCopy" alongside existing path/variant attributes.
General documentation updates
docs/get-started/install.mdx, docs/index.mdx, docs/releases/migration-guide-from-older-version.mdx, docs/releases/migration-guide.mdx
Added copyEvent="CreateCommandCopy" to CodeSnippets usages in installation, homepage, and migration guide pages.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Homogeneous, repetitive changes across documentation files.
  • Review focus: ensure attribute value is correct and no accidental edits to surrounding content.
  • Files to spot-check: docs/index.mdx, docs/get-started/install.mdx, and one representative framework file (e.g., docs/get-started/frameworks/react-vite.mdx).

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 cbeb937 and a3f239e.

📒 Files selected for processing (15)
  • docs/get-started/frameworks/angular.mdx (1 hunks)
  • docs/get-started/frameworks/nextjs-vite.mdx (1 hunks)
  • docs/get-started/frameworks/nextjs.mdx (1 hunks)
  • docs/get-started/frameworks/preact-vite.mdx (1 hunks)
  • docs/get-started/frameworks/react-native-web-vite.mdx (1 hunks)
  • docs/get-started/frameworks/react-vite.mdx (1 hunks)
  • docs/get-started/frameworks/react-webpack5.mdx (1 hunks)
  • docs/get-started/frameworks/svelte-vite.mdx (1 hunks)
  • docs/get-started/frameworks/sveltekit.mdx (1 hunks)
  • docs/get-started/frameworks/vue3-vite.mdx (1 hunks)
  • docs/get-started/frameworks/web-components-vite.mdx (1 hunks)
  • docs/get-started/install.mdx (1 hunks)
  • docs/index.mdx (1 hunks)
  • docs/releases/migration-guide-from-older-version.mdx (1 hunks)
  • docs/releases/migration-guide.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (10)
  • docs/get-started/frameworks/web-components-vite.mdx
  • docs/get-started/frameworks/svelte-vite.mdx
  • docs/get-started/install.mdx
  • docs/index.mdx
  • docs/get-started/frameworks/nextjs-vite.mdx
  • docs/releases/migration-guide.mdx
  • docs/get-started/frameworks/nextjs.mdx
  • docs/get-started/frameworks/react-vite.mdx
  • docs/get-started/frameworks/sveltekit.mdx
  • docs/releases/migration-guide-from-older-version.mdx
🧰 Additional context used
🧠 Learnings (4)
📚 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/frameworks/angular.mdx
  • docs/get-started/frameworks/preact-vite.mdx
  • docs/get-started/frameworks/vue3-vite.mdx
  • docs/get-started/frameworks/react-native-web-vite.mdx
  • docs/get-started/frameworks/react-webpack5.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/frameworks/angular.mdx
  • docs/get-started/frameworks/preact-vite.mdx
  • docs/get-started/frameworks/vue3-vite.mdx
  • docs/get-started/frameworks/react-native-web-vite.mdx
  • docs/get-started/frameworks/react-webpack5.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/frameworks/preact-vite.mdx
  • docs/get-started/frameworks/react-webpack5.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 README.md : Update relevant README files for significant code changes

Applied to files:

  • docs/get-started/frameworks/react-webpack5.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 (5)
docs/get-started/frameworks/vue3-vite.mdx (1)

15-15: Verify CodeSnippets component supports the copyEvent prop.

The change adds copyEvent="CreateCommandCopy" to the <CodeSnippets> component across all documentation files. This appears to be a new prop for tracking copy events as part of the growth experiment.

Please confirm that the CodeSnippets component has been updated to accept and handle the copyEvent prop. Since only documentation files are provided in this review, verify that the component implementation in the codebase (likely in a docs or components package) properly accepts this prop and integrates with the event tracking system referenced in the accompanyin storybookjs/web PR #363.

docs/get-started/frameworks/react-native-web-vite.mdx (1)

23-23: Consistent with pattern across framework docs.

The change mirrors the pattern applied to all framework installation guides. No issues identified in this file.

docs/get-started/frameworks/react-webpack5.mdx (1)

22-22: Consistent with pattern across framework docs.

The change mirrors the pattern applied to all framework installation guides. No issues identified in this file.

docs/get-started/frameworks/angular.mdx (1)

15-15: Consistent with pattern across framework docs.

The change mirrors the pattern applied to all framework installation guides. No issues identified in this file.

docs/get-started/frameworks/preact-vite.mdx (1)

15-15: Consistent with pattern across framework docs.

The change mirrors the pattern applied to all framework installation guides. No issues identified in this file.


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

@nx-cloud
Copy link

nx-cloud bot commented Dec 3, 2025

View your CI Pipeline Execution ↗ for commit cbeb937

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

☁️ Nx Cloud last updated this comment at 2025-12-03 16:33:50 UTC

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.

🚀 LGTM 🚀

@Sidnioulz Sidnioulz force-pushed the sidnioulz/growth-sb-experiment-followup branch from cbeb937 to a3f239e Compare December 8, 2025 08:09
@shilman shilman changed the title Docs: Follow up on growth experiment event tracking Docs: Follow up on nav experiment Dec 8, 2025
@shilman shilman added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Dec 8, 2025
@shilman shilman merged commit 9548e92 into next Dec 8, 2025
19 of 21 checks passed
@shilman shilman deleted the sidnioulz/growth-sb-experiment-followup branch December 8, 2025 08:27
@shilman shilman added documentation and removed maintenance User-facing maintenance tasks labels Dec 8, 2025
shilman added a commit that referenced this pull request Dec 8, 2025
…ment-followup

Docs: Follow up on nav experiment
(cherry picked from commit 9548e92)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Dec 8, 2025
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 experiment This issue/PR is an experiment; it doesn't always follow production standards but will be monitored. patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants