Skip to content

Conversation

@Sidnioulz
Copy link
Member

@Sidnioulz Sidnioulz commented Dec 29, 2025

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:

image

Documentation

N/A

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

Summary by CodeRabbit

  • Documentation
    • Enhanced configuration documentation with clarification on how Vite-based frameworks handle static directory copying during builds and how to control this behavior through Vite's publicDir configuration option.

✏️ Tip: You can customize this high-level summary in your review settings.

@Sidnioulz Sidnioulz requested a review from kylegach as a code owner December 29, 2025 14:48
@Sidnioulz Sidnioulz added the ci:docs Run the CI jobs for documentation checks only. label Dec 29, 2025
@Sidnioulz Sidnioulz force-pushed the sidnioulz/issue-24627-short-term branch from 784c7ce to 6d3ee1f Compare December 29, 2025 14:49
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 29, 2025

📝 Walkthrough

Walkthrough

Documentation 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

Cohort / File(s) Summary
Documentation
docs/api/main-config/main-config-static-dirs.mdx
Added Callout component after staticDirs code example explaining Vite framework behavior when copying static directories to build output, and how to configure Vite's publicDir setting to control this behavior.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes


📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e155919 and 4403440.

📒 Files selected for processing (1)
  • docs/api/main-config/main-config-static-dirs.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). (1)
  • GitHub Check: Core Unit Tests, windows-latest
🔇 Additional comments (2)
docs/api/main-config/main-config-static-dirs.mdx (2)

32-32: LGTM!

The formatting adjustment maintains consistency with the prettier-ignore block structure.


20-22: No issues found. The Vite documentation link is valid and accessible, and the configuration recommendation to set publicDir: false is accurate according to Vite's official documentation.


Comment @coderabbitai help to get the list of available commands and usage tips.

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.

@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

Comment on lines +20 to +22
<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>
Copy link
Contributor

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?

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants