Skip to content

Commit 9d0d9d4

Browse files
Copilotfi3ework
andauthored
docs: fix various documentation errors: grammar, spelling, and formatting issues (#1179)
Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: fi3ework <[email protected]>
1 parent 8016f47 commit 9d0d9d4

File tree

7 files changed

+12
-12
lines changed

7 files changed

+12
-12
lines changed

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ decisions when appropriate.
5252

5353
This Code of Conduct applies within all community spaces, and also applies when
5454
an individual is officially representing the community in public spaces.
55-
Examples of representing our community include using an official e-mail address,
55+
Examples of representing our community include using an official email address,
5656
posting via an official social media account, or acting as an appointed
5757
representative at an online or offline event.
5858

website/docs/en/config/lib/bundle.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ We should specify the entry file for the build.
1313

1414
### bundle: true
1515

16-
When `bundle` is set to `true`, the entry should be set to the entry file. The default entry in bundle mode is `src/index.(ts|js|tsx|jsx|mjs|cjs)`. You should make sure that the entry file exists, or customize entry through the [source.entry](https://rsbuild.rs/config/source/entry) configuration.
16+
When `bundle` is set to `true`, the entry should be set to the entry file. The default entry in bundle mode is `src/index.(ts|js|tsx|jsx|mjs|cjs)`. You should make sure that the entry file exists, or customize the entry through the [source.entry](https://rsbuild.rs/config/source/entry) configuration.
1717

1818
**Example:**
1919

website/docs/en/config/lib/out-base.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,6 @@ dist
5353

5454
::: tip
5555

56-
When the project needs to generate declaration files, to ensure that the generated declaration files and JS files maintain a consistent output directory structure, if you modify the `outBase` configuration, you need to make sure that the [rootDir](https://www.typescriptlang.org/tsconfig/rootDir.html) in `tsconfig.json` to the same path.
56+
When the project needs to generate declaration files, to ensure that the generated declaration files and JS files maintain a consistent output directory structure, if you modify the `outBase` configuration, you need to make sure that the [rootDir](https://www.typescriptlang.org/tsconfig/rootDir.html) in `tsconfig.json` is set to the same path.
5757

5858
:::

website/docs/en/config/lib/shims.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Options:
7676
);
7777
```
7878
79-
- `false`: the `import.meta.url` will be leave as is, which will cause a runtime error when running the output.
79+
- `false`: the `import.meta.url` will be left as is, which will cause a runtime error when running the output.
8080
8181
## shims.esm
8282
@@ -110,7 +110,7 @@ Options:
110110
console.log(src_filename);
111111
```
112112
113-
- `false`: the `__filename` will be leave as is, which will cause a runtime error when running the output.
113+
- `false`: the `__filename` will be left as is, which will cause a runtime error when running the output.
114114
115115
### shims.esm.\_\_dirname
116116
@@ -139,7 +139,7 @@ Options:
139139
console.log(src_dirname);
140140
```
141141
142-
- `false`: the `__dirname` will be leave as is, which will cause a runtime error when running the output.
142+
- `false`: the `__dirname` will be left as is, which will cause a runtime error when running the output.
143143
144144
### shims.esm.require
145145
@@ -149,7 +149,7 @@ Whether to inject shims for the global `require` of CommonJS in ESM output.
149149
150150
Options:
151151
152-
- `true`: when [format](/config/lib/format) is `esm`, there will be a `require` that created by `createRequire` at the beginning of the output which can be accessed in source code like the global `require` like CommonJS.
152+
- `true`: when [format](/config/lib/format) is `esm`, there will be a `require` that is created by `createRequire` at the beginning of the output which can be accessed in source code like the global `require` like CommonJS.
153153
154154
For example, given the following source code:
155155
@@ -181,4 +181,4 @@ Options:
181181
lazyFn('./other.js', require);
182182
```
183183
184-
- `false`: the `require` will be leave as is, which will cause a runtime error when running the output.
184+
- `false`: the `require` will be left as is, which will cause a runtime error when running the output.

website/docs/en/guide/advanced/module-federation.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,8 @@ Then run the `dev` command can start the Module Federation development mode, ena
181181
First, set up Storybook with the Rslib project. You can refer to the [Storybook chapter](/guide/advanced/storybook) to learn how to do this. In this chapter, we will use React as the framework for our example.
182182

183183
1. Install the following Storybook addons to let Storybook work with Rslib Module Federation:
184-
- [storybook-addon-rslib](https://www.npmjs.com/package/storybook-addon-rslib): Storybook addon that let Storybook to load the Rslib config.
185-
- [@module-federation/storybook-addon](https://www.npmjs.com/package/@module-federation/rsbuild-plugin): Storybook addon that set up the Module Federation config for Storybook.
184+
- [storybook-addon-rslib](https://www.npmjs.com/package/storybook-addon-rslib): Storybook addon that lets Storybook load the Rslib config.
185+
- [@module-federation/storybook-addon](https://www.npmjs.com/package/@module-federation/rsbuild-plugin): Storybook addon that sets up the Module Federation config for Storybook.
186186

187187
<PackageManagerTabs command="add storybook-addon-rslib @module-federation/storybook-addon -D" />
188188

website/docs/en/guide/faq/features.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ export default defineConfig({
3939

4040
### How to skip the processing of static asset files in bundleless mode?
4141

42-
In bundleless mode, Rslib transforms the source static asset file into a JavaScript file and a static asset file that is emitted according to [output.distPath](/config/rsbuild/output#outputdistpath) by default with preserving the `import` or `require` statements for static assets. To skip the above processing of static asset files, you need to:
42+
In bundleless mode, Rslib transforms the source static asset file into a JavaScript file and a static asset file that is emitted according to [output.distPath](/config/rsbuild/output#outputdistpath) by default, while preserving the `import` or `require` statements for static assets. To skip the above processing of static asset files, you need to:
4343

4444
1. Set `source.entry` to remove static asset files from the entry.
4545
2. Set `output.copy` to copy static asset files to the output directory.

website/docs/en/guide/migration/tsup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,6 @@ Here is the corresponding Rslib configuration for tsup configuration:
6666

6767
## Contents supplement
6868

69-
The current document only covers part of the migration process. If you find suitable content to add, feel free to contribute to the documentation via pull request 🤝.
69+
The current document only covers part of the migration process. If you find suitable content to add, feel free to contribute to the documentation via a pull request 🤝.
7070

7171
> The documentation for Rslib can be found in the [rslib/website](https://github.com/web-infra-dev/rslib/tree/main/website) directory.

0 commit comments

Comments
 (0)