Skip to content

Conversation

@tijmenb
Copy link
Contributor

@tijmenb tijmenb commented Jul 2, 2025

What I did

Update the docs for https://storybook.js.org/docs/essentials/backgrounds

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

Make sure the snippet works out of the box.

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

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 canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

Updates the TypeScript import syntax in the backgrounds configuration documentation snippet to use explicit type imports.

  • Modified import statement from import { Preview } from '@storybook/your-framework' to import { type Preview } from '@storybook/your-framework' in docs/_snippets/addon-backgrounds-options-in-preview.md
  • Change aligns with TypeScript best practices for type imports which can improve build performance
  • Documentation-only change that affects the backgrounds addon configuration example

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

1 file reviewed, no comments
Edit PR Review Bot Settings | Greptile

@jonniebigodes jonniebigodes changed the title Fix type import in background code snippet Docs: Fix type import in background code snippet Jul 2, 2025
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tijmenb, thanks for putting together this pull request and helping us improve the documentation by catching this minor issue with the example. Appreciate it 🙏

Left one small item for you to address when you can.
Let me know once you've addressed it, and gladly merge it.

Hope you have a fantastic day.

Stay safe

@jonniebigodes jonniebigodes self-assigned this Jul 2, 2025
@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels Jul 2, 2025
@nx-cloud
Copy link

nx-cloud bot commented Jul 2, 2025

View your CI Pipeline Execution ↗ for commit e87b871.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 15s View ↗

☁️ Nx Cloud last updated this comment at 2025-07-03 18:13:36 UTC

@jonniebigodes
Copy link
Contributor

@tijmenb thanks for addressing the feedback so promptly. Appreciate it 🙏 ! I'll gladly merge this once the checklist clears. Have a fantastic day.

@jonniebigodes jonniebigodes merged commit cb315cb into storybookjs:next Jul 3, 2025
7 checks passed
ghengeveld pushed a commit that referenced this pull request Jul 8, 2025
Docs: Fix type import in background code snippet
(cherry picked from commit cb315cb)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jul 8, 2025
@greptile-apps greptile-apps bot mentioned this pull request Aug 11, 2025
17 tasks
@ndelangen ndelangen removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Oct 28, 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 patch:done Patch/release PRs already cherry-picked to main/release branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants