Skip to content

Commit e42c711

Browse files
jonniebigodesstorybook-bot
authored andcommitted
Merge pull request #32797 from storybookjs/sidnioulz/fix-addons-doc-keywords
Docs: Fix up references to old storybook-addons keyword (cherry picked from commit 03f6307)
1 parent 4b6c160 commit e42c711

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/addons/integration-catalog.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ Add your addon to the catalog by publishing a npm package that follows these req
2424

2525
### Addon metadata
2626

27-
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.
27+
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.
2828

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

3737
Customize your addon's appearance by adding the `storybook` property with the following fields.
@@ -69,7 +69,7 @@ Use the list below as a reference when filling in the values for both the `suppo
6969
"url": "https://github.com/chromaui/storybook-addon-example"
7070
},
7171
"author": "winkerVSbecks",
72-
"keywords": ["storybook-addons", "style", "debug", "layout", "css"],
72+
"keywords": ["storybook-addon", "style", "debug", "layout", "css"],
7373
"storybook": {
7474
"displayName": "Outline",
7575
"unsupportedFrameworks": ["vue"],

docs/addons/writing-addons.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,15 +215,15 @@ The second metadata category is related to the [integration catalog](https://sto
215215
"unsupportedFrameworks": ["react-native"],
216216
"icon": "https://yoursite.com/link-to-your-icon.png"
217217
},
218-
"keywords": ["storybook-addons", "appearance", "style", "css", "layout", "debug"]
218+
"keywords": ["storybook-addon", "appearance", "style", "css", "layout", "debug"]
219219
}
220220
```
221221

222222
<Callout variant="info">
223223
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).
224224
</Callout>
225225

226-
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.
226+
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.
227227

228228
### Publishing to NPM
229229

0 commit comments

Comments
 (0)