Merge pull request #25381 from storybookjs/docs_fix_test_api_reference

Docs: Build feature option fixes
storybookjs · Dec 29, 2023 · a9503dc · a9503dc
2 parents acb96db + 64e7968
commit a9503dc
Show file tree

Hide file tree

Showing 13 changed files with 14 additions and 14 deletions.
diff --git a/docs/api/main-config-build.md b/docs/api/main-config-build.md
@@ -25,11 +25,11 @@ 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).
 
 <Callout variant="info" icon="💡">
 
-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.
 
 </Callout>
 

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -9,7 +9,7 @@ const config: StorybookConfig = {
   stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
   build: {
     test: {
-      disableTreeShaking: true,
+      disableTreeShaking: false,
     },
   },
 };