Document how to add individual story description, see #8527 #10823 #15417
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
Nx Cloud ReportCI ran the following commands for commit e1a4b2c. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this branch
Sent with 💌 from NxCloud. |
added 2 commits
June 29, 2021 14:41
shilman
requested changes
Jun 29, 2021
There was a problem hiding this comment.
This is actually the deprecated way of doing it. The recommended way is here:
https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#docs-description-parameter
|
Oh, I did not find that method either, I just updated my example, or is it documented elsewhere? |
|
@vidhill yes, documented here https://storybook.js.org/docs/react/writing-docs/doc-blocks#description |
|
Shall I close/cancel this PR so? |
shilman
reviewed
Jun 30, 2021
shilman
approved these changes
Jun 30, 2021
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.
Issue:
What I did
Update docs to show how to add individual story description in
CSFsee #8527 #10823- I spent a silly amount of time trying to find this piece of info, I want to save the next person the trouble
How to test