Skip to content
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

Migrate away from mdx stories to CSF format #291

Open
Tracked by #21415
brionmario opened this issue Oct 14, 2024 · 0 comments
Open
Tracked by #21415

Migrate away from mdx stories to CSF format #291

brionmario opened this issue Oct 14, 2024 · 0 comments
Labels
package:react Issues/PRs related to the `@oxygen-ui/react` package. 💅 storybook Issues related to Storybook. Type/Improvement

Comments

@brionmario
Copy link
Member

brionmario commented Oct 14, 2024

Is your suggestion related to an experience? Please describe.

We are currently using Storybook v6, which supports stories written in both mdx and CSF formats. However, with our planned migration to Storybook v8 (see issue #52), it is recommended to move away from the mdx format and standardize on the CSF format for better compatibility with the new version and improved scalability.

Describe the improvement

  • Migrate all existing mdx stories to CSF format to align with Storybook v8 requirements.
  • CSF is more compatible with Storybook v8 and offers better integration with advanced features like dynamic rendering, story controls, and addon management.
  • This migration will enhance the maintainability of the codebase and streamline future upgrades or enhancements.
  • CSF simplifies the separation of components and narratives, making it easier for developers to create, modify, and manage stories as the library grows.

Additional context

  • Migrating to CSF will prepare us for the transition to Storybook v8.
  • Storybook v8 has dropped some mdx features in favor of CSF for better support of the latest tooling and community standards.
  • You can refer to the Storybook v8 migration guide and the CSF documentation for conversion guidelines.
@brionmario brionmario added package:react Issues/PRs related to the `@oxygen-ui/react` package. 💅 storybook Issues related to Storybook. Type/Improvement labels Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package:react Issues/PRs related to the `@oxygen-ui/react` package. 💅 storybook Issues related to Storybook. Type/Improvement
Projects
None yet
Development

No branches or pull requests

1 participant