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/tests: add examples of before and after #2

Closed
tobiasdiez opened this issue Oct 1, 2022 · 6 comments
Closed

docs/tests: add examples of before and after #2

tobiasdiez opened this issue Oct 1, 2022 · 6 comments
Labels
documentation Improvements or additions to documentation

Comments

@tobiasdiez
Copy link
Owner

tobiasdiez commented Oct 1, 2022

https://storybook.js.org/docs/vue/writing-stories/introduction

add them to https://storybook.js.org/docs/svelte/contribute/new-snippets

@tobiasdiez tobiasdiez added the documentation Improvements or additions to documentation label Oct 1, 2022
@tobiasdiez tobiasdiez changed the title docs: add example of before and after docs/tests: add examples of before and after Nov 10, 2022
@tobiasdiez
Copy link
Owner Author

@JReinhold @IanVS would you guys accept PRs adding the "vue native" story format to the official documentation? A few people are already using the addon, and it seems stable enough for them (there were a few feature requests but no serious bug reports).

@JReinhold
Copy link

That would be a question for @jonniebigodes and @kylegach, the docs maintainers. 🙏

@tobiasdiez
Copy link
Owner Author

@jonniebigodes and @kylegach, any input on this?

@jonniebigodes
Copy link

@tobiasdiez sorry for the delay in following up with you on this issue, but there were other items that required my attention. I've talked with the team, and before committing to extending the documentation featuring the addon we'd like some additional clarification on what's currently supported by the addon in terms of features (e.g., args, interaction testing with the play function, etc.) so that we're aware of what's currently supported and what's not so that we can plan ahead and see how best to start documenting and come up with a plan moving forward in terms of maintenance and contributors willing to help us support it.

Let me know and we'll go from there.

Hope you have a great day.

Stay safe

@tobiasdiez
Copy link
Owner Author

No worries, and thanks for looking into this.

Currently, most of the basic features are implemented. This includes essentially everything in the documentation https://storybook.js.org/docs/vue/writing-stories/introduction, including the play function. Parameters and decorators are not yet supported, but would be straightforward to implement. Args are missing, mostly because they feel a bit awkward from a vue perspective (see eg #13 and #1). I've started to translate some of the examples in the docs to the "vue native" format, and this can be found at https://640982c419c9697b75bfd8fb-mhfqpmbmbk.chromatic.com. So these features are definitely working, but many other examples would be straightforward to translate - I just haven't found the time yet and wanted to wait for your feedback.

Let me know if you have any other questions!

@tobiasdiez
Copy link
Owner Author

@jonniebigodes any update on this?

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
Projects
None yet
Development

No branches or pull requests

3 participants