-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
Docs: Mention Vite publicDir interference #33438
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
base: next
Are you sure you want to change the base?
Conversation
784c7ce to
6d3ee1f
Compare
📝 WalkthroughWalkthroughDocumentation update adds an informational callout explaining Vite-based framework behavior with static directories. The callout clarifies that extra directories may be copied to build output due to Vite's asset handling, and documents how to disable this via Vite's publicDir configuration option. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
⏰ 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)
🔇 Additional comments (2)
Comment |
6d3ee1f to
4403440
Compare
jonniebigodes
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.
@Sidnioulz thanks for taking the time to put together this pull request and helping us improve the documentation with this interesting caveat. Appreciate it 🙏 ! I left one small item for you to look into when you can.
Let me know once you've addressed it and will be more than glad to merge this and get the docs updated.
Have a great day
Stay safe
| <Callout variant="info"> | ||
| When using Vite-based frameworks, additional directories may be copied to your build directory because of Vite's own [static asset handling](https://vite.dev/guide/assets#the-public-directory). You can set Vite's `publicDir` option to `false` to disable this behavior. | ||
| </Callout> |
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.
@Sidnioulz, when you're able, can you add the same callout in https://storybook.js.org/docs/configure/integration/images-and-assets#serving-static-files-via-storybook-configuration for a bit more visibility so that this information doesn't stay "buried" in the configuration docs?
What I did
Short term fix for #24627 until the issue can be addressed, as it could involve breaking changes.
Checklist for Contributors
Testing
N/A
Manual testing
N/A, docs. Visit http://localhost:3000/docs/api/main-config/main-config-static-dirs for outcome:
Documentation
N/A
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
publicDirconfiguration option.✏️ Tip: You can customize this high-level summary in your review settings.