Skip to content
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.

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

Docs: Fix typo in multiple files of docs and code folder #24541

Merged
merged 6 commits into from
Oct 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CONTRIBUTING/RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,7 @@ No process is defined for this.

### Merges to `main` without versioning

As described in more details in [the Patch Releases section](#patch-releases), there are scenarios where you want to patch [unreleasable](#which-changes-are-considered-releasable-and-what-does-it-mean) content back to `main` without bumping versions or publishing a new release. This happens automatically as long as all the unpicked patch pull requests have unreleasable labels. In that case the prepared patch pull request will change form slighty, to just cherry-picking the patches without bumping the versions.
As described in more details in [the Patch Releases section](#patch-releases), there are scenarios where you want to patch [unreleasable](#which-changes-are-considered-releasable-and-what-does-it-mean) content back to `main` without bumping versions or publishing a new release. This happens automatically as long as all the unpicked patch pull requests have unreleasable labels. In that case the prepared patch pull request will change form slightly, to just cherry-picking the patches without bumping the versions.

## FAQ

Expand Down
4 changes: 2 additions & 2 deletions code/frameworks/nextjs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ export default {

### Options

You can be pass an options object for addional configuration if needed.
You can be pass an options object for additional configuration if needed.

For example:

Expand Down Expand Up @@ -864,7 +864,7 @@ Next.js comes with a lot of things for free out of the box like sass support, bu

Any webpack modifications desired for Storybook should be made in [.storybook/main.js](https://storybook.js.org/docs/react/builders/webpack#extending-storybooks-webpack-config).

Note: Not all webpack modifications are copy/paste-able between `next.config.js` and `.storybook/main.js`. It is recommended to do your reasearch on how to properly make your modifcation to Storybook's webpack config and on how [webpack works](https://webpack.js.org/concepts/).
Note: Not all webpack modifications are copy/paste-able between `next.config.js` and `.storybook/main.js`. It is recommended to do your research on how to properly make your modification to Storybook's webpack config and on how [webpack works](https://webpack.js.org/concepts/).

Below is an example of how to add svgr support to Storybook with this framework.

Expand Down
2 changes: 1 addition & 1 deletion code/lib/instrumenter/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Storybook Instrumenter

The Storybook Instrumenter is used to patch a (3rd party) module to track and intercept function invocations for step-through debugging using the Interactions addon. In essense, the Instrumenter traverses a given object, recursively monkey-patching any functions to make them "tracked".
The Storybook Instrumenter is used to patch a (3rd party) module to track and intercept function invocations for step-through debugging using the Interactions addon. In essence, the Instrumenter traverses a given object, recursively monkey-patching any functions to make them "tracked".

During normal operation, tracked functions simply call through to their original function, forwarding the return value. As a side-effect, they also emit a `call` event whenever they are invoked.

Expand Down
2 changes: 1 addition & 1 deletion code/lib/postinstall/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Storybook Postinstall Utilties
# Storybook Postinstall Utilities

A minimal utility library for addons to update project configurations after the addon is installed via the [Storybook CLI](https://github.com/storybookjs/storybook/tree/main/lib/cli), e.g. `sb add docs`.

Expand Down
2 changes: 1 addition & 1 deletion code/presets/create-react-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ module.exports = {

### Custom `react-scripts` packages

In most cases, this preset will find your `react-scripts` package, even if it's a fork of the offical `react-scripts`.
In most cases, this preset will find your `react-scripts` package, even if it's a fork of the official `react-scripts`.

In the event that it doesn't, you can set the package's name with `scriptsPackageName`.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/main-config-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,4 +204,4 @@ Enable crash reports to be sent to Storybook [telemetry](../configure/telemetry.

Type: `RendererName`

<!-- TOOD: Is this used? Should it be documented? -->
<!-- TODO: Is this used? Should it be documented? -->
2 changes: 1 addition & 1 deletion docs/sharing/publish-storybook.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Examples: [Netlify](https://www.netlify.com/), [S3](https://aws.amazon.com/en/s3

## Search engine optimization (SEO)

If your Storybook is publically viewable, you may wish to configure how it is represented in search engine result pages.
If your Storybook is publicly viewable, you may wish to configure how it is represented in search engine result pages.

### Description

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const DelayedStory: Story = {

const exampleElement = canvas.getByLabelText('example-element');

// The delay option set the ammount of milliseconds between characters being typed
// The delay option sets the amount of milliseconds between characters being typed
await userEvent.type(exampleElement, 'random string', {
delay: 100,
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export const DelayedStory = {

const exampleElement = canvas.getByLabelText('example-element');

// The delay option set the ammount of milliseconds between characters being typed
// The delay option sets the amount of milliseconds between characters being typed
await userEvent.type(exampleElement, 'random string', {
delay: 100,
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const DelayedStory: Story = {

const exampleElement = canvas.getByLabelText('example-element');

// The delay option set the ammount of milliseconds between characters being typed
// The delay option sets the amount of milliseconds between characters being typed
await userEvent.type(exampleElement, 'random string', {
delay: 100,
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const DelayedStory: Story = {

const exampleElement = canvas.getByLabelText('example-element');

// The delay option set the ammount of milliseconds between characters being typed
// The delay option sets the amount of milliseconds between characters being typed
await userEvent.type(exampleElement, 'random string', {
delay: 100,
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export const DelayedStory = {

const exampleElement = canvas.getByLabelText('example-element');

// The delay option set the ammount of milliseconds between characters being typed
// The delay option sets the amount of milliseconds between characters being typed
await userEvent.type(exampleElement, 'random string', {
delay: 100,
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export const DelayedStory: Story = {

const exampleElement = canvas.getByLabelText('example-element');

// The delay option set the ammount of milliseconds between characters being typed
// The delay option sets the amount of milliseconds between characters being typed
await userEvent.type(exampleElement, 'random string', {
delay: 100,
});
Expand Down