Set up Storybook and use that for documentation #11
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is something that I've been working on sporadically in the background for a while, but I think it's at a point where it makes sense to set it up and we can continue to add more to it later. The basic idea of this is that it sets up Storybook for the toolkit. Storybook is a development/testing/documentation tool for UI components that I think will be really useful for us. The interactivity of the Storybook sandbox/documentation also makes this a great way to show off the capabilities of the toolkit to anyone outside the team who might be interested. Note that this replaces the TypeDoc setup that I had previously configured.
There's a lot that we can do here, this just sets up our basic configuration. I'll continue to add more stories and functionality in the background. Note that currently this setup doesn't include anything that doesn't get used in a component with a story, but I'm looking into how to integrate things like utility functions into this.