Skip to content

Commit

Permalink
Docs: Fix links and assorted fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@jonniebigodes
jonniebigodes committed Jul 9, 2024
1 parent 41053bf commit 9f16fe1
Show file tree
Hide file tree
Showing 50 changed files with 506 additions and 438 deletions.
18 changes: 9 additions & 9 deletions MAINTAINERS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ This document outlines some of the processes that the maintainers should adhere
| label name | purpose |
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| accessibility | Issue, bug, or pull request related to accessibility |
| addon:(name) | Issue, bug, or pull request related to Storybook addons (e.g., [Controls](/docs/essentials/controls.md)) |
| addon:(name) | Issue, bug, or pull request related to Storybook addons (e.g., [Controls](/docs/essentials/controls.mdx)) |
| app:(name) | Issue, bug, or pull request related to Storybook's supported frameworks (e.g., React) |
| api:(name) | Issue, bug, or pull request related to Storybook's API (e.g.,[makeDecorator](/docs/addons/addons-api.md#makeDecorator-API)) |
| args | Issue, bug, or pull request related to Storybook's [args](/docs/writing-stories/args.md) |
| api:(name) | Issue, bug, or pull request related to Storybook's API (e.g.,[makeDecorator](/docs/addons/addons-api.mdx#makeDecorator-API)) |
| args | Issue, bug, or pull request related to Storybook's [args](/docs/writing-stories/args.mdx) |
| babel/webpack | Issue, bug, or pull request related to Storybook's build system (e.g., Webpack or Babel), for Webpack 5 issues see below |
| block:(name) | Issue or bug within a certain surface are of Storybook (e.g., [argsTable](/docs/writing-docs/doc-block-argstable.md)) |
| block:(name) | Issue or bug within a certain surface are of Storybook (e.g., [argTypes](/docs/api/doc-blocks/doc-block-argtypes.mdx)) |
| BREAKING CHANGE | Issue or pull request that introduces a breaking change within Storybook's ecosystem. |
| BREAKING PRERELASE | Breaking, but only for prerelease users (not relative to the stable release) |
| build-storybook | Issue, bug, or pull request related to Storybook's production build |
Expand All @@ -24,12 +24,12 @@ This document outlines some of the processes that the maintainers should adhere
| cli | Issue, bug, or pull request that affects the Storybook's CLI |
| compatibility with other tools | Issue, bug, or pull request between Storybook and other tools (e.g., [Nuxt](https://nuxtjs.org/)) |
| components | Issue, bug, or pull request related to Storybook's internal components |
| composition | Issue, bug, or pull request related to Storybook [Composition](/docs/sharing/storybook-composition.md) |
| configuration | Issue, bug, or pull request related to Storybook [configuration](/docs/configure/index.md) |
| composition | Issue, bug, or pull request related to Storybook [Composition](/docs/sharing/storybook-composition.mdx) |
| configuration | Issue, bug, or pull request related to Storybook [configuration](/docs/configure/index.mdx) |
| core | Issue, bug, or pull request related to Storybook's Core |
| cra | Issue, bug, or pull request that affects Storybook's compatibility with Create React APP ([CRA](https://create-react-app.dev/docs/getting-started/)) |
| CSF | Issue, bug, or pull request related to Storybook's [Component Story Format (CSF)](/docs/api/csf.md) |
| decorators | Issue, bug, or pull related to Storybook's [Decorators](/docs/writing-stories/decorators.md) |
| CSF | Issue, bug, or pull request related to Storybook's [Component Story Format (CSF)](/docs/api/csf.mdx) |
| decorators | Issue, bug, or pull related to Storybook's [Decorators](/docs/writing-stories/decorators.mdx) |
| dependencies | Issue, bug, or pull request that related to upstream dependencies |
| discussion | Issue currently being discussed between the maintainers and community |
| do not merge | Pull request that will introduce regressions and will not be merged |
Expand Down Expand Up @@ -68,7 +68,7 @@ This document outlines some of the processes that the maintainers should adhere
| security | Issue, bug, or pull request that addresses security with Storybook |
| small | Issue or pull request that requires a small amount of work to be done |
| source-loader | Issue, bug, or pull request related to code display within Storybook's stories |
| theming | Issue, bug, or pull request related to Storybook customization (e.g., [theming](/docs/configure/theming.md)) |
| theming | Issue, bug, or pull request related to Storybook customization (e.g., [theming](/docs/configure/user-interface/theming.mdx)) |
| todo | Issue or pull request currently being worked on |
| typescript | Issue, bug, or pull request related to TypeScript |
| ui | Issue, bug, or pull request related to Storybook's UI |
Expand Down
2 changes: 1 addition & 1 deletion docs/addons/addons-api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ The following table details how to use the API values:
| **selectedPanel** | String | Id to select an addon panel | `storybook/actions/panel` |
| **initialActive** | String | Select the default active tab on Mobile | `sidebar` or `canvas` or `addons` |
| **sidebar** | Object | Sidebar options, see below | `{ showRoots: false }` |
| **toolbar** | Object | Modify the tools in the toolbar using the addon id | `{ fullscreen: { hidden: false } } }` |
| **toolbar** | Object | Modify the tools in the toolbar using the addon id | `{ fullscreen: { hidden: false } }` |

The following options are configurable under the `sidebar` namespace:

Expand Down
2 changes: 1 addition & 1 deletion docs/addons/integration-catalog.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Storybook addons are distributed via npm. The catalog is populated by querying n

Add your addon to the catalog by publishing a npm package that follows these requirements:

* `package.json` with [module information](./writing-addons.mdx#get-started) and [addon metadata](#addon-metadata)
* `package.json` with [module information](./writing-addons.mdx#setup) and [addon metadata](#addon-metadata)
* `README.md` file with installation and configuration instructions
* `/dist` directory containing transpiled ES5 code
* `preset.js` file written as an ES5 module at the root level
Expand Down
6 changes: 3 additions & 3 deletions docs/api/arg-types.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ Default: [Inferred](#automatic-argtype-inference); `'select'`, if [`options`](#o

Specifies the type of control used to change the arg value with the [controls addon](../essentials/controls.mdx). Here are the available types, `ControlType`, grouped by the type of data they handle:

| Data type | ControlType | Description |
| -------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Data type | ControlType | Description |
| -------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **array** | `'object'` | Provides a JSON-based editor to handle the values of the array. Also allows editing in raw mode.<br /> `{ control: 'object' }` |
| **boolean** | `'boolean'` | Provides a toggle for switching between possible states.<br /> `{ control: 'boolean' }` |
| **enum** | `'check'` | Provides a set of stacked checkboxes for selecting multiple options.<br /> `{ control: 'check', options: ['email', 'phone', 'mail'] }` |
Expand All @@ -139,7 +139,7 @@ Specifies the type of control used to change the arg value with the [controls ad
| **object** | `'file'` | Provides a file input that returns an array of URLs. Can be further customized to accept specific file types.<br /> `{ control: { type: 'file', accept: '.png' } }` |
| | `'object'` | Provides a JSON-based editor to handle the object's values. Also allows editing in raw mode.<br /> `{ control: 'object' }` |
| **string** | `'color'` | Provides a color picker to choose color values. Can be additionally configured to include a set of color presets.<br /> `{ control: { type: 'color', presetColors: ['red', 'green']} }` |
| | `'date'` | Provides a datepicker to choose a date.<br /> `{ control: 'date' }` |
| | `'date'` | Provides a datepicker to choose a date.<br /> `{ control: 'date' }` |
| | `'text'` | Provides a freeform text input.<br /> `{ control: 'text' }` |

<Callout variant="info" icon="💡">
Expand Down
Loading

0 comments on commit 9f16fe1

Please sign in to comment.