diff --git a/docs/addons/integration-catalog.mdx b/docs/addons/integration-catalog.mdx index 16fef2dd7853..e92266353666 100644 --- a/docs/addons/integration-catalog.mdx +++ b/docs/addons/integration-catalog.mdx @@ -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 storybook-addons 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 storybook-addon 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. @@ -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"], diff --git a/docs/addons/writing-addons.mdx b/docs/addons/writing-addons.mdx index 619c79a51530..ce809705fb5d 100644 --- a/docs/addons/writing-addons.mdx +++ b/docs/addons/writing-addons.mdx @@ -215,7 +215,7 @@ 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"] } ``` @@ -223,7 +223,7 @@ The second metadata category is related to the [integration catalog](https://sto 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). -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