-
-
Notifications
You must be signed in to change notification settings - Fork 9.7k
CSF: Fix incorrect CSF constructs #32231
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
Merged
jonniebigodes
merged 4 commits into
next
from
docs_snippets_fix_incorrect_csf_constructs
Aug 11, 2025
Merged
CSF: Fix incorrect CSF constructs #32231
jonniebigodes
merged 4 commits into
next
from
docs_snippets_fix_incorrect_csf_constructs
Aug 11, 2025
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
4 files reviewed, no comments
View your CI Pipeline Execution ↗ for commit b1d992e
☁️ Nx Cloud last updated this comment at |
kylegach
approved these changes
Aug 11, 2025
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.
LGTM
This was referenced Aug 11, 2025
Merged
ndelangen
pushed a commit
that referenced
this pull request
Aug 20, 2025
…t_csf_constructs Docs: Fix incorrect CSF constructs (cherry picked from commit 737cabc)
ndelangen
pushed a commit
that referenced
this pull request
Aug 21, 2025
…t_csf_constructs Docs: Fix incorrect CSF constructs (cherry picked from commit 737cabc)
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
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #
What I did
With this pull request, some of the CSF stories constructs were updated to align with the rest of the documentation and prevent misconceptions
What was done:
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH 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.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 canary-release-pr.yml --field pr=<PR_NUMBER>
Greptile Summary
This PR standardizes CSF (Component Story Format) constructs across Storybook documentation snippets to align with modern TypeScript best practices and ensure consistency throughout the codebase. The changes focus on four documentation files that contain code examples used throughout the Storybook documentation.
The key improvements include:
satisfies
operator instead of explicit type annotations on meta objects, providing better type inference while maintaining type safetyStoryObj<typeof Component>
toStoryObj<typeof meta>
for better type consistency across story definitionsexport default meta
declarationsThese documentation snippets are used as reference examples throughout Storybook's documentation system. The updated patterns demonstrate current best practices that provide better TypeScript support and align with how modern Storybook applications should be structured. The changes ensure that developers copying these examples will use the most effective patterns available, preventing the propagation of outdated or suboptimal CSF constructs.
The affected files (
play-function.md
,my-component-skip-tags.md
,my-component-include-tags.md
, andmy-component-exclude-tags.md
) serve as template snippets that are likely referenced across multiple documentation pages, making this standardization effort particularly valuable for maintaining consistency across the entire documentation ecosystem.Confidence score: 5/5
Context used:
Context - When documenting code snippets, ensure to include Svelte CSF and CSF examples, and also include JS and TypeScript variants. (link)