Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Maintenance - Fix snippets and documentation #29683

Merged
merged 9 commits into from
Nov 22, 2024
Merged

Docs: Maintenance - Fix snippets and documentation #29683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5667488
Starter documentation and snippet fixes
jonniebigodes Nov 17, 2024
c454698
More snippet fixes
jonniebigodes Nov 17, 2024
99c5d14
Additional fixes to docs and snippets
jonniebigodes Nov 21, 2024
8125c77
Revert misc change in the readmes
jonniebigodes Nov 21, 2024
e97dfc1
Address feedback
jonniebigodes Nov 21, 2024
72d7c82
Minor snippet fixes
jonniebigodes Nov 21, 2024
cbdfcb5
Merge branch 'next' into docs_fix_snippets_v3
jonniebigodes Nov 22, 2024
5b2efc2
Merge branch 'next' into docs_fix_snippets_v3
jonniebigodes Nov 22, 2024
726dd05
Additional cleanup
jonniebigodes Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Binary file added docs/_assets/contribute/local-storybook-website-dropdown-optimized.mp4
View file
Open in desktop
Binary file not shown.
Binary file removed docs/_assets/contribute/local-storybook-website-dropdown-optimized.png
View file
Open in desktop
Binary file not shown.
4 changes: 0 additions & 4 deletions docs/_snippets/add-localize-package-to-polyfills.md
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion docs/_snippets/addon-actions-action-function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,3 @@ const meta: Meta {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/addon-backgrounds-grid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,4 +131,3 @@ const meta: Meta = {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/addon-consume-and-update-globaltype.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,3 @@ const ExampleToolbar = () => {
);
};
```

1 change: 0 additions & 1 deletion docs/_snippets/addon-consume-globaltype.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,3 @@ const ThemePanel = (props) => {
);
};
```

1 change: 0 additions & 1 deletion docs/_snippets/addon-highlight-reset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,4 +240,3 @@ export const ResetHighlight: Story = {
],
};
```

2 changes: 1 addition & 1 deletion docs/_snippets/addon-test-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```

Expand Down
1 change: 0 additions & 1 deletion docs/_snippets/angular-install.md
View file
Open in desktop
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
```

1 change: 0 additions & 1 deletion docs/_snippets/angular-project-compodoc-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,3 @@
}
}
```

1 change: 0 additions & 1 deletion docs/_snippets/api-doc-block-argtypes-parameter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,3 @@ const meta: Meta<typeof Button> = {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/api-doc-block-canvas-parameter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,3 @@ export const Basic: Story = {
},
};
```

1 change: 0 additions & 1 deletion docs/_snippets/api-doc-block-controls-parameter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,3 @@ const meta: Meta = {

export default meta;
```

25 changes: 14 additions & 11 deletions docs/_snippets/api-doc-block-description-example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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> = {
Expand All @@ -22,7 +22,7 @@ export default meta;
type Story = StoryObj<Button>;

/**
* # Primary Button
* Primary Button
* This is the primary button
*/
export const Primary: Story = {
Expand All @@ -40,7 +40,7 @@ export const Primary: Story = {
import { Button } from './Button';

/**
* # Button stories
* Button stories
* These stories showcase the button
*/
export default {
Expand All @@ -55,7 +55,7 @@ export default {
}

/**
* # Primary Button
* Primary Button
* This is the primary button
*/
export const Primary = {
Expand All @@ -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 = {
Expand All @@ -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 = {
Expand All @@ -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> = {
Expand All @@ -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 = {
Expand All @@ -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',
Expand Down Expand Up @@ -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 = {
Expand All @@ -198,7 +202,7 @@ export default meta;
type Story = StoryObj;

/**
* # Primary Button
* Primary Button
* This is the primary button
*/
export const Primary: Story = {
Expand All @@ -211,4 +215,3 @@ export const Primary: Story = {
},
};
```

1 change: 0 additions & 1 deletion docs/_snippets/api-doc-block-source-parameter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,3 @@ export const Basic: Story = {
},
};
```

1 change: 0 additions & 1 deletion docs/_snippets/api-doc-block-story-parameter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,3 @@ export const Basic: Story = {
},
};
```

38 changes: 0 additions & 38 deletions docs/_snippets/apollo-module.md
View file
Open in desktop

This file was deleted.

98 changes: 0 additions & 98 deletions docs/_snippets/apollo-wrapper-component.md
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion docs/_snippets/arg-types-control.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,4 +119,3 @@ const meta: Meta = {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/arg-types-default-value.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,4 +119,3 @@ const meta: Meta = {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/arg-types-description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,3 @@ const meta: Meta = {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/arg-types-if.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,4 +221,3 @@ const meta: Meta = {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/arg-types-in-meta.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,3 @@ const meta: Meta = {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/arg-types-in-preview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,3 @@ const preview: Preview = {

export default preview;
```

1 change: 0 additions & 1 deletion docs/_snippets/arg-types-mapping.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,3 @@ const meta: Meta = {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/arg-types-name.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,3 @@ const meta: Meta = {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/arg-types-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,3 @@ const meta: Meta = {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/arg-types-table.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,3 @@ const meta: Meta = {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/arg-types-type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,3 @@ const meta: Meta = {

export default meta;
```

1 change: 0 additions & 1 deletion docs/_snippets/args-in-preview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ const preview: Preview = {

export default preview;
```

1 change: 0 additions & 1 deletion docs/_snippets/args-usage-with-addons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@ resetArgs((argNames: ['key']));
// To reset all args
resetArgs();
```

Loading