From 53450ae577698b2d66ed7042a0bd76a6bc9adc8c Mon Sep 17 00:00:00 2001 From: jonniebigodes Date: Fri, 29 Dec 2023 12:15:08 +0000 Subject: [PATCH 1/2] Docs: Build feature option fixes --- docs/api/main-config-build.md | 2 +- docs/snippets/common/main-config-test-disable-autodocs.js.mdx | 2 +- docs/snippets/common/main-config-test-disable-autodocs.ts.mdx | 2 +- docs/snippets/common/main-config-test-disable-blocks.js.mdx | 2 +- docs/snippets/common/main-config-test-disable-blocks.ts.mdx | 2 +- docs/snippets/common/main-config-test-disable-docgen.js.mdx | 2 +- docs/snippets/common/main-config-test-disable-docgen.ts.mdx | 2 +- docs/snippets/common/main-config-test-disable-mdx.js.mdx | 2 +- docs/snippets/common/main-config-test-disable-mdx.ts.mdx | 2 +- docs/snippets/common/main-config-test-disable-sourcemaps.js.mdx | 2 +- docs/snippets/common/main-config-test-disable-sourcemaps.ts.mdx | 2 +- .../snippets/common/main-config-test-disable-treeshaking.js.mdx | 2 +- .../snippets/common/main-config-test-disable-treeshaking.ts.mdx | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/api/main-config-build.md b/docs/api/main-config-build.md index a206662bae4a..34c2329695ee 100644 --- a/docs/api/main-config-build.md +++ b/docs/api/main-config-build.md @@ -25,7 +25,7 @@ Type: `TestBuildFlags` } ``` -Configures Storybook's production builds for performance testing purposes by disabling certain features from the build. When running ' build-storybook ', this feature is enabled by setting the `--test` [flag](./cli-options.md#build). +Configures Storybook's production builds for performance testing purposes by disabling certain features from the build. When running `build-storybook`, this feature is enabled by setting the `--test` [flag](./cli-options.md#build). diff --git a/docs/snippets/common/main-config-test-disable-autodocs.js.mdx b/docs/snippets/common/main-config-test-disable-autodocs.js.mdx index 86b7de8fb7b3..006903bad2ea 100644 --- a/docs/snippets/common/main-config-test-disable-autodocs.js.mdx +++ b/docs/snippets/common/main-config-test-disable-autodocs.js.mdx @@ -7,7 +7,7 @@ export default { stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'], build: { test: { - disableAutoDocs: true, + disableAutoDocs: false, }, }, }; diff --git a/docs/snippets/common/main-config-test-disable-autodocs.ts.mdx b/docs/snippets/common/main-config-test-disable-autodocs.ts.mdx index 1eb9e7218197..4a1bd49e9bd1 100644 --- a/docs/snippets/common/main-config-test-disable-autodocs.ts.mdx +++ b/docs/snippets/common/main-config-test-disable-autodocs.ts.mdx @@ -9,7 +9,7 @@ const config: StorybookConfig = { stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'], build: { test: { - disableAutoDocs: true, + disableAutoDocs: false, }, }, }; diff --git a/docs/snippets/common/main-config-test-disable-blocks.js.mdx b/docs/snippets/common/main-config-test-disable-blocks.js.mdx index 9b4aa8c9a478..2ebd0640731d 100644 --- a/docs/snippets/common/main-config-test-disable-blocks.js.mdx +++ b/docs/snippets/common/main-config-test-disable-blocks.js.mdx @@ -7,7 +7,7 @@ export default { stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'], build: { test: { - disableBlocks: true, + disableBlocks: false, }, }, }; diff --git a/docs/snippets/common/main-config-test-disable-blocks.ts.mdx b/docs/snippets/common/main-config-test-disable-blocks.ts.mdx index 0cb4b4235bba..1a647bf092ec 100644 --- a/docs/snippets/common/main-config-test-disable-blocks.ts.mdx +++ b/docs/snippets/common/main-config-test-disable-blocks.ts.mdx @@ -9,7 +9,7 @@ const config: StorybookConfig = { stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'], build: { test: { - disableBlocks: true, + disableBlocks: false, }, }, }; diff --git a/docs/snippets/common/main-config-test-disable-docgen.js.mdx b/docs/snippets/common/main-config-test-disable-docgen.js.mdx index ffe4bdc2f866..38d822c83bef 100644 --- a/docs/snippets/common/main-config-test-disable-docgen.js.mdx +++ b/docs/snippets/common/main-config-test-disable-docgen.js.mdx @@ -7,7 +7,7 @@ export default { stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'], build: { test: { - disableDocgen: true, + disableDocgen: false, }, }, }; diff --git a/docs/snippets/common/main-config-test-disable-docgen.ts.mdx b/docs/snippets/common/main-config-test-disable-docgen.ts.mdx index 1d0eb3c10d9d..ed1df8facc77 100644 --- a/docs/snippets/common/main-config-test-disable-docgen.ts.mdx +++ b/docs/snippets/common/main-config-test-disable-docgen.ts.mdx @@ -9,7 +9,7 @@ const config: StorybookConfig = { stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'], build: { test: { - disableDocgen: true, + disableDocgen: false, }, }, }; diff --git a/docs/snippets/common/main-config-test-disable-mdx.js.mdx b/docs/snippets/common/main-config-test-disable-mdx.js.mdx index f6204594c1ef..133f34d570bb 100644 --- a/docs/snippets/common/main-config-test-disable-mdx.js.mdx +++ b/docs/snippets/common/main-config-test-disable-mdx.js.mdx @@ -7,7 +7,7 @@ export default { stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'], build: { test: { - disableMDXEntries: true, + disableMDXEntries: false, }, }, }; diff --git a/docs/snippets/common/main-config-test-disable-mdx.ts.mdx b/docs/snippets/common/main-config-test-disable-mdx.ts.mdx index e5327602aed8..5c364f466658 100644 --- a/docs/snippets/common/main-config-test-disable-mdx.ts.mdx +++ b/docs/snippets/common/main-config-test-disable-mdx.ts.mdx @@ -9,7 +9,7 @@ const config: StorybookConfig = { stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'], build: { test: { - disableMDXEntries: true, + disableMDXEntries: false, }, }, }; diff --git a/docs/snippets/common/main-config-test-disable-sourcemaps.js.mdx b/docs/snippets/common/main-config-test-disable-sourcemaps.js.mdx index 9207b9317099..8e2772ca1f1f 100644 --- a/docs/snippets/common/main-config-test-disable-sourcemaps.js.mdx +++ b/docs/snippets/common/main-config-test-disable-sourcemaps.js.mdx @@ -7,7 +7,7 @@ export default { stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'], build: { test: { - disableSourcemaps: true, + disableSourcemaps: false, }, }, }; diff --git a/docs/snippets/common/main-config-test-disable-sourcemaps.ts.mdx b/docs/snippets/common/main-config-test-disable-sourcemaps.ts.mdx index 79b0abab693d..2fa419b94976 100644 --- a/docs/snippets/common/main-config-test-disable-sourcemaps.ts.mdx +++ b/docs/snippets/common/main-config-test-disable-sourcemaps.ts.mdx @@ -9,7 +9,7 @@ const config: StorybookConfig = { stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'], build: { test: { - disableSourcemaps: true, + disableSourcemaps: false, }, }, }; diff --git a/docs/snippets/common/main-config-test-disable-treeshaking.js.mdx b/docs/snippets/common/main-config-test-disable-treeshaking.js.mdx index f0957f7e5536..cbf3c7a29eaf 100644 --- a/docs/snippets/common/main-config-test-disable-treeshaking.js.mdx +++ b/docs/snippets/common/main-config-test-disable-treeshaking.js.mdx @@ -7,7 +7,7 @@ export default { stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'], build: { test: { - disableTreeShaking: true, + disableTreeShaking: false, }, }, }; diff --git a/docs/snippets/common/main-config-test-disable-treeshaking.ts.mdx b/docs/snippets/common/main-config-test-disable-treeshaking.ts.mdx index b053cfa03435..eccb38910d1f 100644 --- a/docs/snippets/common/main-config-test-disable-treeshaking.ts.mdx +++ b/docs/snippets/common/main-config-test-disable-treeshaking.ts.mdx @@ -9,7 +9,7 @@ const config: StorybookConfig = { stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'], build: { test: { - disableTreeShaking: true, + disableTreeShaking: false, }, }, }; From 9fea5e9f6b6f4c66f80916ae82442ce5f2dc3984 Mon Sep 17 00:00:00 2001 From: jonniebigodes Date: Fri, 29 Dec 2023 13:10:27 +0000 Subject: [PATCH 2/2] Polish aside wording --- docs/api/main-config-build.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/main-config-build.md b/docs/api/main-config-build.md index 34c2329695ee..e9c4c5adc001 100644 --- a/docs/api/main-config-build.md +++ b/docs/api/main-config-build.md @@ -29,7 +29,7 @@ Configures Storybook's production builds for performance testing purposes by dis -Enabling these features can cause build or runtime errors with Storybook. We recommend enabling only the features you need for your project. +The options documented on this page are automatically enabled when the `--test` flag is provided to the `build-storybook` command. We encourage you to override these options only if you need to disable a specific feature for your project or if you are debugging a build issue.