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

docs: add Storybook usage guide #52

Open
shinGangan opened this issue Jan 25, 2024 · 4 comments
Open

docs: add Storybook usage guide #52

shinGangan opened this issue Jan 25, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@shinGangan
Copy link
Contributor

shinGangan commented Jan 25, 2024

Context

Components stories such as Storybook, Histoire, etc. are often prepared for web application development.
With vite support for Storybook, I believe there are many opportunities for users to use Storybook together with Panda CSS Module (I use Panda CSS + Storybook + Storybook Module in my product development).

Considering the opportunities for users, it would be great if Panda CSS Module can provide storybook: boolean option + automatic setup.
However, we also think it is beyond the responsibility of Panda CSS Module. Might as well keep it to "clearly state how to use in Docs".

So, I would like to hear the owner's ( @wattanx ) view.

Design: if you want to provide a storybook option.

if storybook(sb) = true:

  1. install Storybook Module and npx storybook-module init
  2. add Storybook Module to nuxt.config.ts

Note

We consider the result of the discussion of this feature to have an impact of one minor version up.
Therefore, we recognize that the priority of response and discussion is low (because it does not require urgency, such as a malfunctioning bug).

Ref

@wattanx
Copy link
Owner

wattanx commented Jan 26, 2024

I think it would be better not to support the storybook option.
It would be good to add an introduction procedure to the docs.

I think integration with storybooks should be an add-on on the storybook side. (e.g. storybook-pandacss-addon)
(This is my thinking at this time, and my ideas may change in the future.)

@shinGangan
Copy link
Contributor Author

I think it would be better not to support the storybook option.
It would be good to add an introduction procedure to the docs.

I agree with you 👍 .
I don't know if the Storybook side needs to be addressed first (add addons) or the Panda CSS side (can be done via CLI, etc.), but I think the Docs description policy is fine for now.

Can Docs support be implemented as is with this issue number?
Or, should I close this Issue and tie it to another Issue?

@wattanx
Copy link
Owner

wattanx commented Jan 26, 2024

Let's use this issue as it is!

@shinGangan shinGangan changed the title feat: Support Storybook Options docs: add Storybook usage guide Jan 26, 2024
@shinGangan
Copy link
Contributor Author

OK. Title was changed 👍

I think this is a low priority, so you can assign it on me. 🙆
I will deal with it between jobs.

@wattanx wattanx added the enhancement New feature or request label Jan 26, 2024
@wattanx wattanx added the documentation Improvements or additions to documentation label Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants