From 1d9d092b4af5dda4d60007aa2b255f438712b27a Mon Sep 17 00:00:00 2001 From: Michael Shilman Date: Wed, 23 Oct 2019 23:06:46 +0800 Subject: [PATCH] Addon-docs: document story description --- addons/docs/docs/docspage.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/addons/docs/docs/docspage.md b/addons/docs/docs/docspage.md index 40119a951a3..5e286be9ee4 100644 --- a/addons/docs/docs/docspage.md +++ b/addons/docs/docs/docspage.md @@ -77,6 +77,8 @@ Here is a summary of the slots, where the data comes from by default, and the sl | Props | component docgen props or propTypes | `propsSlot` | React, Vue | | Stories | storybook stories | `storiesSlot` | All | +The `storiesSlot` uses the `docs.storyDescription` parameter to show a description for each story, if available. + For more information on frameworks, see ["Framework support"](../README.md#framework-support) ### Title @@ -261,7 +263,6 @@ addParameters({ With that function, anyone using the docs addon for `@storybook/vue` can make their stories render inline, either globally with the `inlineStories` docs parameter, or on a per-story-basis using the `inline` prop on the `` doc block. If you come up with an elegant and flexible implementation for the `prepareForInline` function for your own framework, let us know! We'd love to make it the default configuration, to make inline stories more accessible for a larger variety of frameworks! - ## More resources Want to learn more? Here are some more articles on Storybook Docs: