Add story creation guide #52
Merged
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
1 participant
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 adds a guide to the Storybook documentation (under "Documentation > Creating a Story") giving a simple multi-step walkthrough on how to create a story. The idea here is to help someone get a basic understanding of how to use the CosmicDS toolkit and template by guiding them through a recreation of the Carina story (chosen because it's probably the simplest one from a technical standpoint). Along the way we give lots of sample code snippets, which are all in a code block component which has a button to allow copying their text.
Any thoughts or suggestions on the content are welcome, and please let me know if you see any errors. Suggestions on styling would be great too, as I haven't spent a ton of time thinking about it here. I've run through this sequence using the stock template myself and everything seems to work fine, but it's certainly possible that I've missed some things.