-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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: Update theming example #28614
Docs: Update theming example #28614
Conversation
Update the import statement example to match conventions in storybook 8.2.x and newer
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.
PR Summary
- Updated import path in
/docs/_snippets/storybook-theme-example-variables.md
to@storybook/theming
- Resolved build errors by removing
/create
from the import path - Fixed TypeScript error related to
ThemeVars
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
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.
@booc0mtaco, thank you for putting together this pull request and helping us improve the documentation by catching this small issue with our examples. We appreciate it 🙏 !
I've checked, and everything is good on my end.
I'm going to merge this once the checklist clears.
I hope you have a great day.
Stay safe
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 5482a5c. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
Update the import statement example to match conventions in storybook 8.2.x and newer
Repository / Pull Request in question: chanzuckerberg/edu-design-system@5299632
Closes #
What I did
After updating to the latest storybook release (8.2.x), I started getting errors when starting local development, and in CI
Snippet:
Also, there is a typescript error in my theme file:
This theme file follows the directions in the documentation mentioned here. However, after investigating, I found a thread mentioning an alternative import statement that I tried, which worked. Here, I update the code example to use that import path. In code, removing
/create
from the path fixes the TypeScript Error, and allows the build to pass.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/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>