diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 960213c37073..638e1aade6f2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -175,7 +175,7 @@ So the way our script works is that it: Our script leaves the local registry running, for **as long as you keep it running** you can install storybook packages from this local registry. - Navigate to your own project and then change `package.json` so the storybook packages match the version of the one you just published. -- Then just do the normal install procedure using `yarn` or `npm` +- Then you can install using `yarn` or `npm` - Start using your storybook as normally. If you've made a change to storybook's codebase and would want this change to be reflected in your app: @@ -229,7 +229,7 @@ We use the following label scheme to categorize issues: All issues should have a `type` label. `bug`/`feature`/`question`/`discussion` are self-explanatory. `dependencies` is for keeping package dependencies up to date. `maintenance` is a catch-all for any kind of cleanup or refactoring. -They should also have one or more `area`/`status` labels. We use these labels to filter issues down so we can easily see all of the issues for a particular area, and keep the total number of open issues under control. +They should also have one or more `area`/`status` labels. We use these labels to filter issues down so we can see all of the issues for a particular area, and keep the total number of open issues under control. For example, here is the list of [open, untyped issues](https://github.com/storybookjs/storybook/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20-label%3A%22bug%22%20-label%3A%22discussion%22%20-label%3A%22feature%22%20-label%3A%22maintenance%22%20-label%3A%22question%20%2F%20support%22%20-label%3A%22documentation%22%20-label%3A%22greenkeeper%22), or here is a list of [bugs that have not been modified since 2017-04-01](https://github.com/storybookjs/storybook/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22bug%22%20updated%3A%3C%3D2017-04-01%20). For more info see [searching issues](https://help.github.com/articles/searching-issues/) in the Github docs. diff --git a/MIGRATION.md b/MIGRATION.md index cdfdb289a85c..ada5ec601e25 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -655,7 +655,7 @@ Storybook now uses Babel 7. There's a couple of cases when it can break with you If you are using `create-react-app` (aka CRA), you may need to do some manual steps to upgrade, depending on the setup. - `create-react-app@1` may require manual migrations. - - If you're adding storybook for the first time, it should just work: `sb init` should add the correct dependencies. + - If you're adding storybook for the first time: `sb init` should add the correct dependencies. - If you're upgrading an existing project, your `package.json` probably already uses Babel 6, making it incompatible with `@storybook/react@4` which uses Babel 7. There are two ways to make it compatible, each of which is spelled out in detail in the next section: - Upgrade to Babel 7 if you are not dependent on Babel 6-specific features. - Migrate Babel 6 if you're heavily dependent on some Babel 6-specific features). @@ -748,7 +748,7 @@ This was done to support different major versions of babel. ### Base webpack config now contains vital plugins ([#1775](https://github.com/storybookjs/storybook/pull/1775)) -This affects you if you use custom webpack config in [Full Control Mode](https://storybook.js.org/configurations/custom-webpack-config/#full-control-mode) while not preserving the plugins from `storybookBaseConfig`. Before `3.3`, preserving them was just a recommendation, but now it [became](https://github.com/storybookjs/storybook/pull/2578) a requirement. +This affects you if you use custom webpack config in [Full Control Mode](https://storybook.js.org/configurations/custom-webpack-config/#full-control-mode) while not preserving the plugins from `storybookBaseConfig`. Before `3.3`, preserving them was a recommendation, but now it [became](https://github.com/storybookjs/storybook/pull/2578) a requirement. ### Refactored Knobs @@ -879,7 +879,7 @@ The new package names are: | `@kadira/storybook-addon-graphql` | `@storybook/addon-graphql` | | `@kadira/react-storybook-decorator-centered` | `@storybook/addon-centered` | -If your codebase is small, it's probably doable to just replace them by hand. (in your codebase and in `package.json`). +If your codebase is small, it's probably doable to replace them by hand (in your codebase and in `package.json`). But if you have a lot of occurrences in your codebase, you can use a [codemod we created](./lib/codemod) for you. diff --git a/ROADMAP.md b/ROADMAP.md index f98687178543..82f11931ff23 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -24,7 +24,7 @@ Doing these will be backwards compatible. ### Responsive + multi-device viewports preview. -If you're smart about it you can already view the preview on multiple devices and windows. It's just an iframe after-all. +If you're smart about it you can already view the preview on multiple devices and windows. It's an iframe after-all. But story selection and addon-settings are not synced. We want to make this much much simpler and a core feature of storybook. diff --git a/addons/contexts/README.md b/addons/contexts/README.md index 3362dfa6fdff..c781dacbe0e9 100644 --- a/addons/contexts/README.md +++ b/addons/contexts/README.md @@ -25,7 +25,7 @@ once then apply it everywhere**. 1. Define a single global file for managing contextual environments (a.k.a. containers) for all of your stories declaratively. No more repetitive setups or noisy wrapping, making your stories more focused and readable. -2. Support dynamic contextual props switching from Storybook toolbar at runtime. You can easily slice into +2. Support dynamic contextual props switching from Storybook toolbar at runtime. You can slice into different environments (e.g. languages or themes ) to understand how your component is going to respond. 3. Library agnostic: no presumption on what kind of components you want to wrap around your stories. You can even use it to bridge with your favorite routing, state-management solutions, or even your own @@ -65,7 +65,7 @@ import { contexts } from './configs/contexts'; // we will define the contextual addDecorator(withContexts(contexts)); ``` -Alternatively, just like other addons, you can use this addon only for a given set of stories: +Alternatively, like other addons, you can use this addon only for a given set of stories: ```js import { storiesOf } from '@storybook/[framework]'; @@ -220,7 +220,7 @@ be shown at first in the toolbar menu in your Storybook. ## đź“” Notes -1. You can use this addon to inject any valid components, that is why `icon` and `params` can be just optional. +1. You can use this addon to inject any valid components, that is why `icon` and `params` can be optional. 2. As mentioned, extra contextual environment setups can be added at the story level. Please make sure they are passed via the second argument as `{ contexts: [{ /* extra contexts */ }}`. 3. Additional `params` can be "appended" into an existing setup at the story level too (make sure it goes with the diff --git a/addons/docs/docs/docspage.md b/addons/docs/docs/docspage.md index 900f6d6c48f9..4b5bf43f9086 100644 --- a/addons/docs/docs/docspage.md +++ b/addons/docs/docs/docspage.md @@ -241,7 +241,7 @@ The docs preset assumes this naming convention for its `source-loader` setup. If Due to the complex nature of writing a cross-framework utility like Storybook, the story blocks for most frameworks exist within an `