Merge pull request #29683 from storybookjs/docs_fix_snippets_v3

Docs: Maintenance - Fix snippets and documentation (cherry picked from commit 896be2b)
storybookjs · Nov 29, 2024 · 725a098 · 725a098
1 parent 578ba77
commit 725a098
Show file tree

Hide file tree

Showing 537 changed files with 1,717 additions and 1,918 deletions.
diff --git a/docs/_assets/contribute/local-storybook-website-dropdown-optimized.mp4 b/docs/_assets/contribute/local-storybook-website-dropdown-optimized.mp4
diff --git a/docs/_assets/contribute/local-storybook-website-dropdown-optimized.png b/docs/_assets/contribute/local-storybook-website-dropdown-optimized.png
diff --git a/docs/_snippets/add-localize-package-to-polyfills.md b/docs/_snippets/add-localize-package-to-polyfills.md
diff --git a/docs/_snippets/addon-actions-action-function.md b/docs/_snippets/addon-actions-action-function.md
@@ -91,4 +91,3 @@ const meta: Meta {
 
 export default meta;
 ```
-
diff --git a/docs/_snippets/addon-backgrounds-grid.md b/docs/_snippets/addon-backgrounds-grid.md
@@ -131,4 +131,3 @@ const meta: Meta = {
 
 export default meta;
 ```
-
diff --git a/docs/_snippets/addon-consume-and-update-globaltype.md b/docs/_snippets/addon-consume-and-update-globaltype.md
@@ -38,4 +38,3 @@ const ExampleToolbar = () => {
   );
 };
 ```
-
diff --git a/docs/_snippets/addon-consume-globaltype.md b/docs/_snippets/addon-consume-globaltype.md
@@ -38,4 +38,3 @@ const ThemePanel = (props) => {
   );
 };
 ```
-
diff --git a/docs/_snippets/addon-highlight-reset.md b/docs/_snippets/addon-highlight-reset.md
@@ -240,4 +240,3 @@ export const ResetHighlight: Story = {
   ],
 };
 ```
-
diff --git a/docs/_snippets/addon-test-install.md b/docs/_snippets/addon-test-install.md
@@ -1,4 +1,4 @@
-```shell renderer="common" language="js" packageManager="npx"
+```shell renderer="common" language="js" packageManager="npm"
 npx storybook add @storybook/experimental-addon-test
 ```
 

diff --git a/docs/_snippets/angular-install.md b/docs/_snippets/angular-install.md
@@ -9,4 +9,3 @@ pnpm add --save-dev @storybook/angular
 ```shell renderer="angular" language="js" packageManager="yarn"
 yarn add --dev @storybook/angular
 ```
-
diff --git a/docs/_snippets/angular-project-compodoc-config.md b/docs/_snippets/angular-project-compodoc-config.md
@@ -46,4 +46,3 @@
   }
 }
 ```
-
diff --git a/docs/_snippets/api-doc-block-argtypes-parameter.md b/docs/_snippets/api-doc-block-argtypes-parameter.md
@@ -63,4 +63,3 @@ const meta: Meta<typeof Button> = {
 
 export default meta;
 ```
-
diff --git a/docs/_snippets/api-doc-block-canvas-parameter.md b/docs/_snippets/api-doc-block-canvas-parameter.md
@@ -107,4 +107,3 @@ export const Basic: Story = {
   },
 };
 ```
-
diff --git a/docs/_snippets/api-doc-block-controls-parameter.md b/docs/_snippets/api-doc-block-controls-parameter.md
@@ -94,4 +94,3 @@ const meta: Meta = {
 
 export default meta;
 ```
-
diff --git a/docs/_snippets/api-doc-block-description-example.md b/docs/_snippets/api-doc-block-description-example.md
@@ -4,7 +4,7 @@ import type { Meta, StoryObj } from '@storybook/angular';
 import { Button } from './button.component';
 
 /**
- * # Button stories
+ * Button stories
  * These stories showcase the button
  */
 const meta: Meta<Button> = {
@@ -22,7 +22,7 @@ export default meta;
 type Story = StoryObj<Button>;
 
 /**
- * # Primary Button
+ * Primary Button
  * This is the primary button
  */
 export const Primary: Story = {
@@ -40,7 +40,7 @@ export const Primary: Story = {
 import { Button } from './Button';
 
 /**
- * # Button stories
+ * Button stories
  * These stories showcase the button
  */
 export default {
@@ -55,7 +55,7 @@ export default {
 }
 
 /**
- * # Primary Button
+ * Primary Button
  * This is the primary button
  */
 export const Primary = {
@@ -76,7 +76,7 @@ import type { Meta, StoryObj } from '@storybook/your-framework';
 import { Button } from './Button';
 
 /**
- * # Button stories
+ * Button stories
  * These stories showcase the button
  */
 const meta = {
@@ -94,7 +94,7 @@ export default meta;
 type Story = StoryObj<typeof meta>
 
 /**
- * # Primary Button
+ * Primary Button
  * This is the primary button
  */
 export const Primary: Story = {
@@ -115,7 +115,7 @@ import type { Meta, StoryObj } from '@storybook/your-framework';
 import { Button } from './Button';
 
 /**
- * # Button stories
+ * Button stories
  * These stories showcase the button
  */
 const meta: Meta<typeof Button> = {
@@ -133,7 +133,7 @@ export default meta;
 type Story = StoryObj<typeof Button>;
 
 /**
- * # Primary Button
+ * Primary Button
  * This is the primary button
  */
 export const Primary: Story = {
@@ -148,6 +148,10 @@ export const Primary: Story = {
 ```
 
 ```js filename="Button.stories.js" renderer="web-components" language="js"
+/**
+ * Button stories
+ * These stories showcase the button
+ */
 export default {
   title: 'Button',
   component: 'demo-button',
@@ -179,7 +183,7 @@ export const Primary = {
 import type { Meta, StoryObj } from '@storybook/web-components';
 
 /**
- * # Button stories
+ * Button stories
  * These stories showcase the button
  */
 const meta: Meta = {
@@ -198,7 +202,7 @@ export default meta;
 type Story = StoryObj;
 
 /**
- * # Primary Button
+ * Primary Button
  * This is the primary button
  */
 export const Primary: Story = {
@@ -211,4 +215,3 @@ export const Primary: Story = {
   },
 };
 ```
-
diff --git a/docs/_snippets/api-doc-block-source-parameter.md b/docs/_snippets/api-doc-block-source-parameter.md
@@ -107,4 +107,3 @@ export const Basic: Story = {
   },
 };
 ```
-
diff --git a/docs/_snippets/api-doc-block-story-parameter.md b/docs/_snippets/api-doc-block-story-parameter.md
@@ -107,4 +107,3 @@ export const Basic: Story = {
   },
 };
 ```
-
diff --git a/docs/_snippets/apollo-module.md b/docs/_snippets/apollo-module.md
diff --git a/docs/_snippets/apollo-wrapper-component.md b/docs/_snippets/apollo-wrapper-component.md
diff --git a/docs/_snippets/arg-types-control.md b/docs/_snippets/arg-types-control.md
@@ -119,4 +119,3 @@ const meta: Meta = {
 
 export default meta;
 ```
-
diff --git a/docs/_snippets/arg-types-default-value.md b/docs/_snippets/arg-types-default-value.md
@@ -119,4 +119,3 @@ const meta: Meta = {
 
 export default meta;
 ```
-
diff --git a/docs/_snippets/arg-types-description.md b/docs/_snippets/arg-types-description.md
@@ -89,4 +89,3 @@ const meta: Meta = {
 
 export default meta;
 ```
-
diff --git a/docs/_snippets/arg-types-if.md b/docs/_snippets/arg-types-if.md
@@ -221,4 +221,3 @@ const meta: Meta = {
 
 export default meta;
 ```
-
diff --git a/docs/_snippets/arg-types-in-meta.md b/docs/_snippets/arg-types-in-meta.md
@@ -101,4 +101,3 @@ const meta: Meta = {
 
 export default meta;
 ```
-
diff --git a/docs/_snippets/arg-types-in-preview.md b/docs/_snippets/arg-types-in-preview.md
@@ -43,4 +43,3 @@ const preview: Preview = {
 
 export default preview;
 ```
-
diff --git a/docs/_snippets/arg-types-mapping.md b/docs/_snippets/arg-types-mapping.md
@@ -117,4 +117,3 @@ const meta: Meta = {
 
 export default meta;
 ```
-
diff --git a/docs/_snippets/arg-types-name.md b/docs/_snippets/arg-types-name.md
@@ -89,4 +89,3 @@ const meta: Meta = {
 
 export default meta;
 ```
-
diff --git a/docs/_snippets/arg-types-options.md b/docs/_snippets/arg-types-options.md
@@ -89,4 +89,3 @@ const meta: Meta = {
 
 export default meta;
 ```
-
diff --git a/docs/_snippets/arg-types-table.md b/docs/_snippets/arg-types-table.md
@@ -107,4 +107,3 @@ const meta: Meta = {
 
 export default meta;
 ```
-
diff --git a/docs/_snippets/arg-types-type.md b/docs/_snippets/arg-types-type.md
@@ -77,4 +77,3 @@ const meta: Meta = {
 
 export default meta;
 ```
-
diff --git a/docs/_snippets/args-in-preview.md b/docs/_snippets/args-in-preview.md
@@ -28,4 +28,3 @@ const preview: Preview = {
 
 export default preview;
 ```
-
diff --git a/docs/_snippets/args-usage-with-addons.md b/docs/_snippets/args-usage-with-addons.md
@@ -12,4 +12,3 @@ resetArgs((argNames: ['key']));
 // To reset all args
 resetArgs();
 ```
-
Original file line number	Diff line number	Diff line change
Expand Up		@@ -91,4 +91,3 @@ const meta: Meta {

		export default meta;
		```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -131,4 +131,3 @@ const meta: Meta = {

		export default meta;
		```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -38,4 +38,3 @@ const ExampleToolbar = () => {
		);
		};
		```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -38,4 +38,3 @@ const ThemePanel = (props) => {
		);
		};
		```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -240,4 +240,3 @@ export const ResetHighlight: Story = {
		],
		};
		```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,4 +9,3 @@ pnpm add --save-dev @storybook/angular
		```shell renderer="angular" language="js" packageManager="yarn"
		yarn add --dev @storybook/angular
		```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -63,4 +63,3 @@ const meta: Meta<typeof Button> = {

		export default meta;
		```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -107,4 +107,3 @@ export const Basic: Story = {
		},
		};
		```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -94,4 +94,3 @@ const meta: Meta = {

		export default meta;
		```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -119,4 +119,3 @@ const meta: Meta = {

		export default meta;
		```