Skip to content

Docs: Fix up references to old storybook-addons keyword #32797

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

Merged
merged 4 commits into from
Oct 27, 2025
Merged

Docs: Fix up references to old storybook-addons keyword #32797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2a0b1f0
Docs: Fix up references to old storybook-addons keyword
Sidnioulz Oct 22, 2025
6410204
Merge branch 'next' into sidnioulz/fix-addons-doc-keywords
jonniebigodes Oct 23, 2025
44b0964
Merge branch 'next' into sidnioulz/fix-addons-doc-keywords
jonniebigodes Oct 27, 2025
5fd5036
Merge branch 'next' into sidnioulz/fix-addons-doc-keywords
jonniebigodes Oct 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/addons/integration-catalog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ Add your addon to the catalog by publishing a npm package that follows these req

### Addon metadata

We rely on metadata to organize your addon in the catalog. You must add the <code>storybook-addons</code> as the first keyword, followed by your addon's category. Additional keywords will be used in search and as tags.
We rely on metadata to organize your addon in the catalog. You must add the <code>storybook-addon</code> as the first keyword, followed by your addon's category. Additional keywords will be used in search and as tags.

| Property | Description | Example |
| ------------- | -------------------------------------- | ------------------------------------------------------------------------- |
| `name` | Addon package name | storybook-addon-example |
| `description` | Addon description | Outline all elements with CSS to help with layout placement and alignment |
| `author` | Name of the author | winkerVSbecks |
| `keywords` | List of keywords to describe the addon | `["storybook-addons","style","debug"]` |
| `keywords` | List of keywords to describe the addon | `["storybook-addon","style","debug"]` |
| `repository` | Addon repository | `{"type": "git","url": "https://github.com/someone/my-addon" }` |

Customize your addon's appearance by adding the `storybook` property with the following fields.
Expand Down Expand Up @@ -69,7 +69,7 @@ Use the list below as a reference when filling in the values for both the `suppo
"url": "https://github.com/chromaui/storybook-addon-example"
},
"author": "winkerVSbecks",
"keywords": ["storybook-addons", "style", "debug", "layout", "css"],
"keywords": ["storybook-addon", "style", "debug", "layout", "css"],
"storybook": {
"displayName": "Outline",
"unsupportedFrameworks": ["vue"],
Expand Down
4 changes: 2 additions & 2 deletions docs/addons/writing-addons.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,15 +215,15 @@ The second metadata category is related to the [integration catalog](https://sto
"unsupportedFrameworks": ["react-native"],
"icon": "https://yoursite.com/link-to-your-icon.png"
},
"keywords": ["storybook-addons", "appearance", "style", "css", "layout", "debug"]
"keywords": ["storybook-addon", "appearance", "style", "css", "layout", "debug"]
}
```

<Callout variant="info">
The `storybook` configuration element includes additional properties that help customize the addon's searchability and indexing. For more information, see the [Integration catalog documentation](./integration-catalog.mdx).
</Callout>

One essential item to note is the `keywords` property as it maps to the catalog's tag system. Adding the `storybook-addons` ensures that the addon is discoverable in the catalog when searching for addons. The remaining keywords help with the searchability and categorization of the addon.
One essential item to note is the `keywords` property as it maps to the catalog's tag system. Adding the `storybook-addon` keyword ensures that the addon is discoverable in the catalog when searching for addons. The remaining keywords help with the searchability and categorization of the addon.

### Publishing to NPM

Expand Down