From a87e90994c29f7e70b7bd5194eeefa4b291d0ee1 Mon Sep 17 00:00:00 2001 From: jonniebigodes Date: Fri, 15 Dec 2023 21:19:27 +0000 Subject: [PATCH 1/2] Docs: Documentation updates for known limitations --- docs/api/doc-block-controls.md | 2 +- docs/api/doc-block-source.md | 12 ++++++++++++ docs/api/doc-block-story.md | 6 ++++++ docs/writing-docs/autodocs.md | 4 ++++ docs/writing-docs/mdx.md | 4 ++++ 5 files changed, 27 insertions(+), 1 deletion(-) diff --git a/docs/api/doc-block-controls.md b/docs/api/doc-block-controls.md index d199c1f3ec9..0320d3e4eba 100644 --- a/docs/api/doc-block-controls.md +++ b/docs/api/doc-block-controls.md @@ -31,7 +31,7 @@ import * as ButtonStories from './Button.stories' -The Controls doc block will only have functioning UI controls if you have also installed and registered [`@storybook/addon-controls`](../essentials/controls.md) (included in [`@storybook/addon-essentials`](../essentials/index.md)). +The Controls doc block will only have functioning UI controls if you have also installed and registered [`@storybook/addon-controls`](../essentials/controls.md) (included in [`@storybook/addon-essentials`](../essentials/index.md)) and haven't turned off inline stories with the [`inlineStories`](./doc-block-story.md#inline) configuration option. diff --git a/docs/api/doc-block-source.md b/docs/api/doc-block-source.md index c4a46005043..479a1518e09 100644 --- a/docs/api/doc-block-source.md +++ b/docs/api/doc-block-source.md @@ -98,6 +98,18 @@ Light mode is only supported when the `Source` block is rendered independently. + + +### `excludeDecorators` + +Type: + +Default: `parameters.docs.source.excludeDecorators` + +Determines if [decorators](../writing-stories/decorators.md) are rendered in the source code snippet. + + + ### `format` Type: `boolean | 'dedent' | BuiltInParserName` diff --git a/docs/api/doc-block-story.md b/docs/api/doc-block-story.md index 0a3470429ac..179d683a2f4 100644 --- a/docs/api/doc-block-story.md +++ b/docs/api/doc-block-story.md @@ -96,6 +96,12 @@ Default: `parameters.docs.story.inline` or `true` (for [supported frameworks](.. Determines whether the story is rendered `inline` (in the same browser frame as the other docs content) or in an iframe. + + +Setting the `inline` option to false will prevent the associated [controls](./doc-block-controls.md) from updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. + + + ### `meta` Type: CSF file exports diff --git a/docs/writing-docs/autodocs.md b/docs/writing-docs/autodocs.md index 96c42c8ba83..d8452ce4eb7 100644 --- a/docs/writing-docs/autodocs.md +++ b/docs/writing-docs/autodocs.md @@ -286,6 +286,10 @@ Additionally, if you're developing using TypeScript, you may need to update Stor If you're still encountering issues, we recommend reaching out to the community using the default communication channels (e.g., [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help)). +### The controls are not updating the story within the auto-generated documentation + +If you turned off inline rendering for your stories via the [`inlineStories`](../api/doc-block-story.md) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. + #### Learn more about Storybook documentation - Autodocs for creating documentation for your stories diff --git a/docs/writing-docs/mdx.md b/docs/writing-docs/mdx.md index bd31e66374a..ce73db8692f 100644 --- a/docs/writing-docs/mdx.md +++ b/docs/writing-docs/mdx.md @@ -455,6 +455,10 @@ Additionally, if you're working with VSCode, you can add the [MDX extension](htt If you're still encountering issues, we recommend reaching out to the community using the default communication channels (e.g., [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help)). +### The controls are not updating the story within the MDX documentation page + +If you turned off inline rendering for your stories via the [`inlineStories`](../api/doc-block-story.md) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. + #### Learn more about Storybook documentation - [Autodocs](./autodocs.md) for creating documentation for your stories From ec290ea8692ef423eb202adc81ec93e195742907 Mon Sep 17 00:00:00 2001 From: jonniebigodes Date: Fri, 22 Dec 2023 12:27:52 +0000 Subject: [PATCH 2/2] Fix links --- docs/api/doc-block-controls.md | 2 +- docs/api/doc-block-source.md | 2 +- docs/writing-docs/autodocs.md | 2 +- docs/writing-docs/mdx.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/doc-block-controls.md b/docs/api/doc-block-controls.md index 0320d3e4eba..fa753933cb3 100644 --- a/docs/api/doc-block-controls.md +++ b/docs/api/doc-block-controls.md @@ -31,7 +31,7 @@ import * as ButtonStories from './Button.stories' -The Controls doc block will only have functioning UI controls if you have also installed and registered [`@storybook/addon-controls`](../essentials/controls.md) (included in [`@storybook/addon-essentials`](../essentials/index.md)) and haven't turned off inline stories with the [`inlineStories`](./doc-block-story.md#inline) configuration option. +The Controls doc block will only have functioning UI controls if you have also installed and registered [`@storybook/addon-controls`](../essentials/controls.md) (included in [`@storybook/addon-essentials`](../essentials/index.md)) and haven't turned off inline stories with the [`inline`](./doc-block-story.md#inline) configuration option. diff --git a/docs/api/doc-block-source.md b/docs/api/doc-block-source.md index 479a1518e09..1c4c68c5051 100644 --- a/docs/api/doc-block-source.md +++ b/docs/api/doc-block-source.md @@ -102,7 +102,7 @@ Light mode is only supported when the `Source` block is rendered independently. ### `excludeDecorators` -Type: +Type: `boolean` Default: `parameters.docs.source.excludeDecorators` diff --git a/docs/writing-docs/autodocs.md b/docs/writing-docs/autodocs.md index d8452ce4eb7..4e066de59f6 100644 --- a/docs/writing-docs/autodocs.md +++ b/docs/writing-docs/autodocs.md @@ -288,7 +288,7 @@ If you're still encountering issues, we recommend reaching out to the community ### The controls are not updating the story within the auto-generated documentation -If you turned off inline rendering for your stories via the [`inlineStories`](../api/doc-block-story.md) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. +If you turned off inline rendering for your stories via the [`inline`](../api/doc-block-story.md#inline) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. #### Learn more about Storybook documentation diff --git a/docs/writing-docs/mdx.md b/docs/writing-docs/mdx.md index ce73db8692f..cfe98b9bc4a 100644 --- a/docs/writing-docs/mdx.md +++ b/docs/writing-docs/mdx.md @@ -457,7 +457,7 @@ If you're still encountering issues, we recommend reaching out to the community ### The controls are not updating the story within the MDX documentation page -If you turned off inline rendering for your stories via the [`inlineStories`](../api/doc-block-story.md) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. +If you turned off inline rendering for your stories via the [`inline`](../api/doc-block-story.md#inline) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. #### Learn more about Storybook documentation