✨ Added autodocs to component Storybook Stories #9547
Merged
Conversation
This file contains 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
jtoar
approved these changes
Dec 7, 2023
|
@ahaywood Looks like you need to update the jest snapshots here. You can do that by running the tests with the |
Tobbe
pushed a commit
that referenced
this pull request
Dec 21, 2023
## Feature description
For the Storybook component template, I added `tags: ['autodocs']` to
the `meta` block. In context:
```TypeScript
const meta: Meta<typeof ${pascalName}> = {
component: ${pascalName},
tags: ['autodocs']
}
```
By adding this tag, it will generate documentation for you within
Storybook:
_NOTE: screenshots are from another project, but demonstrate what this
tag will do_
In the sidebar, you'll notice a new link called "Docs." This includes a
summary of all the component, all the props that are passed in, and an
overview of all the stories for this component.
We could do this for cells, layouts, and pages, but I figured it's the
most relevant and helpful on the component level.
---------
Co-authored-by: Dominic Saadi <[email protected]>
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.
Feature description
For the Storybook component template, I added
tags: ['autodocs']to themetablock. In context:By adding this tag, it will generate documentation for you within Storybook:
NOTE: screenshots are from another project, but demonstrate what this tag will do
In the sidebar, you'll notice a new link called "Docs." This includes a summary of all the component, all the props that are passed in, and an overview of all the stories for this component.
We could do this for cells, layouts, and pages, but I figured it's the most relevant and helpful on the component level.