Skip to content

Docs: Recommend Vitest addon instead of Portable stories in Vitest #31712

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
merged 1 commit into from
Jun 16, 2025

Conversation

kylegach
Copy link
Contributor

@kylegach kylegach commented Jun 9, 2025

What I did

  • Hide /docs/api/portable-stories/portable-stories-vitest from sidebar nav
  • Add callout to recommend the Vitest addon (and remove other callouts, to simplify)

Checklist for Contributors

Testing

Manual testing

  1. Sync this branch with locally running docs
  2. Confirm that the API > Portable stories group in the sidebar does not have a Vitest item

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    1MIGRATION.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.

Greptile Summary

Updates documentation to deprecate Portable Stories for Vitest in favor of the official @storybook/addon-vitest package, improving testing guidance clarity.

  • Hides docs/api/portable-stories/portable-stories-vitest.mdx from sidebar navigation to discourage direct portable stories usage
  • Aligns with test runner deprecation rule by adding callout recommending @storybook/addon-vitest addon
  • Simplifies documentation by removing React-specific CSF Factories information
  • Removes redundant version-specific notices for cleaner documentation
  • Improves framework-agnostic approach by standardizing on the Vitest addon

@kylegach kylegach self-assigned this Jun 9, 2025
@kylegach kylegach requested a review from jonniebigodes as a code owner June 9, 2025 18:39
@kylegach kylegach 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 Jun 9, 2025
@kylegach kylegach requested a review from shilman June 9, 2025 18:40
Copy link

nx-cloud bot commented Jun 9, 2025

View your CI Pipeline Execution ↗ for commit a0393bc.

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

☁️ Nx Cloud last updated this comment at 2025-06-09 18:46:11 UTC

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

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

@valentinpalkovic valentinpalkovic merged commit 13db115 into next Jun 16, 2025
10 of 16 checks passed
@valentinpalkovic valentinpalkovic deleted the docs-hide-portable-stories-vitest branch June 16, 2025 10:48
valentinpalkovic added a commit that referenced this pull request Jun 17, 2025
…-vitest

Docs: Recommend Vitest addon instead of Portable stories in Vitest
(cherry picked from commit 13db115)
@github-actions github-actions bot mentioned this pull request Jun 17, 2025
7 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jun 17, 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 patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants