-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
Docs: Rework Get Started page CTA positioning and copy #33069
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
Docs: Rework Get Started page CTA positioning and copy #33069
Conversation
📝 WalkthroughWalkthroughDocumentation homepage restructuring that updates installation instructions to be command-focused, removes introductory content, adds new sections for Supported Frameworks and Additional Resources, swaps code snippet variants to target new users, and reorganizes overall page layout with new components. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. 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.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/index.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 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/index.mdx
📚 Learning: 2025-11-05T09:37:25.920Z
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/components/components/tooltip/WithTooltip.tsx:54-96
Timestamp: 2025-11-05T09:37:25.920Z
Learning: Repo: storybookjs/storybook — In code/core/src/components/components/tooltip/WithTooltip.tsx, the legacy WithTooltip implementation is intentionally reintroduced for backward compatibility and is deprecated; maintainers (per Sidnioulz) do not want maintenance or improvements on it. Prefer WithTooltipNew/Popover; avoid suggesting changes to WithTooltip.* going forward.
Applied to files:
docs/index.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). (2)
- GitHub Check: Danger JS
- GitHub Check: Core Unit Tests, windows-latest
🔇 Additional comments (3)
docs/index.mdx (3)
1-30: Clarify discrepancy with AI-generated summary.The AI summary claims "removed introductory blurb and the 'What is Storybook?' subsection," but line 6 still contains the introductory paragraph. Confirm whether the summary is outdated or if the annotated code view is incomplete.
16-30: CTA positioning restructuring looks good.The reordering and addition of new sections align with the growth experiment objectives: moving framework selection and concepts higher on the page improves discoverability for new users, and the "Additional resources" section provides natural next steps. The copy changes at line 10 are also more action-oriented.
10-12: Verify thatCodeSnippetscomponent supports thevariantprop.The code uses
variant="new-users"on theCodeSnippetscomponent. Documentation indicatesCodeSnippetssupportsfilename,language,renderer,packageManager,tabTitle,path, andusesCsf3props, but does not listvariantas a supported attribute. Confirm this prop is intentionally supported in your Storybook version or that the component gracefully ignores it.The referenced snippet file exists at
docs/_snippets/create-command.md, and the newHomeRenderers,HomeConcepts, andHomeResourcescomponents appear properly integrated as globally available MDX components.
|
View your CI Pipeline Execution ↗ for commit 0115ec1
☁️ Nx Cloud last updated this comment at |
afec951 to
9bad6c7
Compare
ce1a0b1 to
4abbcde
Compare
Co-authored-by: Michael Shilman <[email protected]>
4abbcde to
0115ec1
Compare
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.
These changes are great! Thanks, @Sidnioulz!
What I did
Do not merge that just yet. Content changes for growth experiment.
Checklist for Contributors
Testing
N/A
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