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

Investigate Storybook for documenting component library #410

Closed
jgaehring opened this issue Sep 5, 2020 · 4 comments
Closed

Investigate Storybook for documenting component library #410

jgaehring opened this issue Sep 5, 2020 · 4 comments

Comments

@jgaehring
Copy link
Member

Looks pretty straightforward:

https://storybook.js.org/docs/vue/get-started/install

@jgaehring
Copy link
Member Author

A few issues on install, namlely having to install core-js@3 as a dev dep, as explained in storybookjs/storybook#11255. Hopefully storybookjs/storybook#12312 resolves that and I can remove that as a peer dep.

Looks pretty nice at first glance, although there may be some learning curve. I'm test driving it on my fork for now.

Also, there are apparently some specific caveats with Vue props I'll have to explore in more depth later: https://github.com/storybookjs/storybook/blob/master/app/vue/README.md#vue-notes

jgaehring added a commit to jgaehring/field-kit that referenced this issue Sep 5, 2020
@jgaehring
Copy link
Member Author

I think I ran up against this bug, although I'm not sure: storybookjs/storybook#11051

I tried upgrading as it describes, with npm i -D @storybook/vue@next, but that caused something to break that I didn't exactly want to troubleshoot any further, so I just reverted.

jgaehring added a commit to jgaehring/field-kit that referenced this issue Sep 10, 2020
jgaehring added a commit to jgaehring/field-kit that referenced this issue Sep 10, 2020
@jgaehring
Copy link
Member Author

I believe I have a pretty good foundation laid here. I was going to wait to close this once I had stories written for all the existing components, but I don't want to get to far ahead of myself when there will likely be major API changes taking place as I work on #409. I think I should just make sure the documentation work continues in step with that component development, so the API is being documented as its being established.

I'm also going to keep exploring Storybook to see if it will suffice for component testing (#387).

@jgaehring jgaehring mentioned this issue Sep 12, 2020
@jgaehring
Copy link
Member Author

One final step: added a link in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant