Skip to content

Commit

Permalink
Revise tags docs
Browse files Browse the repository at this point in the history
- Document new API
- Add examples
- Remove `main-config-tags`
- Remove `--tags` and `--exclude-tags` CLI flags
- Remove `autodocs: true | false | 'tag'`
- Remove old snippets
  • Loading branch information
kylegach committed May 6, 2024
1 parent 3317619 commit 28da87c
Show file tree
Hide file tree
Showing 22 changed files with 185 additions and 584 deletions.
4 changes: 0 additions & 4 deletions docs/api/cli-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,6 @@ Options include:
| `--stats-json` | Write stats JSON to disk<br/>`storybook dev ---stats-json /tmp/stats`<br/>NOTE: only works for webpack. |
| `--docs` | Starts Storybook in documentation mode. Learn more about it in [here](../writing-docs/build-documentation.md#preview-storybooks-documentation)<br/>`storybook dev --docs` |
| `--disable-telemetry` | Disables Storybook's telemetry. Learn more about it [here](../configure/telemetry.md)<br/>`storybook dev --disable-telemetry` |
| `--tags` | Select which [story tags](../writing-stories/tags.md) to include. Accepts a comma-seperated string.<br/>`storybook dev --tags "dev,test"` |
| `--exclude-tags` | Select which [story tags](../writing-stories/tags.md) to exclude. Accepts a comma-seperated string.<br/>`storybook dev --tags "docs, test"` |

<Callout variant="warning" id="static-dir-deprecation">

Expand Down Expand Up @@ -82,8 +80,6 @@ Options include:
| `--docs` | Builds Storybook in documentation mode. Learn more about it in [here](../writing-docs/build-documentation.md#publish-storybooks-documentation)<br/>`storybook build --docs` |
| `--disable-telemetry` | Disables Storybook's telemetry. Learn more about it [here](../configure/telemetry.md).<br/>`storybook build --disable-telemetry` |
| `--test` | Optimize Storybook's production build for performance and tests by removing unnecessary features with the `test` option. Learn more [here](../api/main-config-build.md).<br/>`storybook build --test` |
| `--tags` | Select which [story tags](../writing-stories/tags.md) to include. Accepts a comma-seperated string.<br/>`storybook dev --tags "dev,test"` |
| `--exclude-tags` | Select which [story tags](../writing-stories/tags.md) to exclude. Accepts a comma-seperated string.<br/>`storybook dev --tags "docs, test"` |

<!-- Re-read this for accuracy -->

Expand Down
40 changes: 0 additions & 40 deletions docs/api/main-config-tags.md

This file was deleted.

33 changes: 0 additions & 33 deletions docs/snippets/angular/button-story-auto-docs.ts.mdx

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ export default {
addons: ['@storybook/addon-essentials'],
docs: {
//👇 See the table below for the list of supported options
autodocs: 'tag',
defaultName: 'Documentation',
},
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ const config: StorybookConfig = {
addons: ['@storybook/addon-essentials'],
docs: {
//👇 See the table below for the list of supported options
autodocs: 'tag',
defaultName: 'Documentation',
},
};
Expand Down
28 changes: 0 additions & 28 deletions docs/snippets/react/button-story-auto-docs.js.mdx

This file was deleted.

33 changes: 0 additions & 33 deletions docs/snippets/react/button-story-auto-docs.ts-4-9.mdx

This file was deleted.

33 changes: 0 additions & 33 deletions docs/snippets/react/button-story-auto-docs.ts.mdx

This file was deleted.

28 changes: 0 additions & 28 deletions docs/snippets/solid/button-story-auto-docs.js.mdx

This file was deleted.

33 changes: 0 additions & 33 deletions docs/snippets/solid/button-story-auto-docs.ts-4-9.mdx

This file was deleted.

33 changes: 0 additions & 33 deletions docs/snippets/solid/button-story-auto-docs.ts.mdx

This file was deleted.

28 changes: 0 additions & 28 deletions docs/snippets/svelte/button-story-auto-docs.js.mdx

This file was deleted.

33 changes: 0 additions & 33 deletions docs/snippets/svelte/button-story-auto-docs.ts-4-9.mdx

This file was deleted.

33 changes: 0 additions & 33 deletions docs/snippets/svelte/button-story-auto-docs.ts.mdx

This file was deleted.

Loading

0 comments on commit 28da87c

Please sign in to comment.