Skip to content

Commit 5605556

Browse files
easy1090easy1090
authored
chore: optimize packages readme (#174)
1 parent 05737c1 commit 5605556

File tree

10 files changed

+138
-29
lines changed

10 files changed

+138
-29
lines changed

‎packages/client/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1-
# Rsdoctor
1+
# Rsdoctor Client
22

3-
Rsdoctor is a tool for diagnosing and analyzing the build process and build artifacts to help developers quickly identify and solve problems.
3+
This package is the Rsdoctor reporting platform.
44

5-
It also supports Webpack and Rspack builders, as well as various build frameworks, such as Rsbuild.
5+
## features
6+
7+
- Rsdoctor is a one-stop tool for diagnosing and analyzing the build process and build artifacts.
8+
- Rsdoctor is a tool that supports Webpack and Rspack build analysis.
9+
- Rsdoctor is an analysis tool that can display the time-consuming and behavioral details of the compilation.
10+
- Rsdoctor is a tool that provides bundle Diff and other anti-degradation capabilities simultaneously.
611

712
## Documentation
813

14+
https://rsdoctor.dev/
15+
916
## Contributing
1017

1118
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).

‎packages/components/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1-
# Rsdoctor
1+
# Rsdoctor Components
22

3-
Rsdoctor is a tool for diagnosing and analyzing the build process and build artifacts to help developers quickly identify and solve problems.
3+
This package is the Rsdoctor reporting platform’s components.
44

5-
It also supports Webpack and Rspack builders, as well as various build frameworks, such as Rsbuild.
5+
## features
6+
7+
- Rsdoctor is a one-stop tool for diagnosing and analyzing the build process and build artifacts.
8+
- Rsdoctor is a tool that supports Webpack and Rspack build analysis.
9+
- Rsdoctor is an analysis tool that can display the time-consuming and behavioral details of the compilation.
10+
- Rsdoctor is a tool that provides bundle Diff and other anti-degradation capabilities simultaneously.
611

712
## Documentation
813

14+
https://rsdoctor.dev/
15+
916
## Contributing
1017

1118
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).

‎packages/core/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1-
# Rsdoctor
1+
# Rsdoctor Core
22

3-
Rsdoctor is a tool for diagnosing and analyzing the build process and build artifacts to help developers quickly identify and solve problems.
3+
This is the core package of Rsdoctor, providing core tools and analysis capabilities for Rsdoctor plugins.
44

5-
It also supports Webpack and Rspack builders, as well as various build frameworks, such as Rsbuild.
5+
## features
6+
7+
- Rsdoctor is a one-stop tool for diagnosing and analyzing the build process and build artifacts.
8+
- Rsdoctor is a tool that supports Webpack and Rspack build analysis.
9+
- Rsdoctor is an analysis tool that can display the time-consuming and behavioral details of the compilation.
10+
- Rsdoctor is a tool that provides bundle Diff and other anti-degradation capabilities simultaneously.
611

712
## Documentation
813

14+
https://rsdoctor.dev/
15+
916
## Contributing
1017

1118
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).

‎packages/graph/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1-
# Rsdoctor
1+
# Rsdoctor Graph
22

3-
Rsdoctor is a tool for diagnosing and analyzing the build process and build artifacts to help developers quickly identify and solve problems.
3+
This package is the intermediate data layer of Rsdoctor.
44

5-
It also supports Webpack and Rspack builders, as well as various build frameworks, such as Rsbuild.
5+
## features
6+
7+
- Rsdoctor is a one-stop tool for diagnosing and analyzing the build process and build artifacts.
8+
- Rsdoctor is a tool that supports Webpack and Rspack build analysis.
9+
- Rsdoctor is an analysis tool that can display the time-consuming and behavioral details of the compilation.
10+
- Rsdoctor is a tool that provides bundle Diff and other anti-degradation capabilities simultaneously.
611

712
## Documentation
813

14+
https://rsdoctor.dev/
15+
916
## Contributing
1017

1118
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).

‎packages/rspack-plugin/README.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,39 @@
1-
# Rsdoctor
1+
# Rsdoctor plugin
22

3-
Rsdoctor is a tool for diagnosing and analyzing the build process and build artifacts to help developers quickly identify and solve problems.
3+
This Rsdoctor plugin is an analysis plugin for the Rspack builder.
44

5-
It also supports Webpack and Rspack builders, as well as various build frameworks, such as Rsbuild.
5+
## features
6+
7+
- Rsdoctor is a one-stop tool for diagnosing and analyzing the build process and build artifacts.
8+
- Rsdoctor is a tool that supports Webpack and Rspack build analysis.
9+
- Rsdoctor is an analysis tool that can display the time-consuming and behavioral details of the compilation.
10+
- Rsdoctor is a tool that provides bundle Diff and other anti-degradation capabilities simultaneously.
11+
12+
## Note
13+
14+
This plugin is used by the `Rspack` repo to open Rsdoctor, [Quik Start](https://rsdoctor.dev/guide/start/quick-start).
15+
16+
Initialize the RsdoctorRspackPlugin in the [plugins](https://www.rspack.dev/config/plugins.html#plugins) of `rspack.config.js`:
17+
18+
```js title="rspack.config.js"
19+
const { RsdoctorRspackPlugin } = require('@rsdoctor/rspack-plugin');
20+
21+
module.exports = {
22+
// ...
23+
plugins: [
24+
// Only register the plugin when RSDOCTOR is true, as the plugin will increase the build time.
25+
process.env.RSDOCTOR &&
26+
new RsdoctorRspackPlugin({
27+
// plugin options
28+
}),
29+
].filter(Boolean),
30+
};
31+
```
632

733
## Documentation
834

35+
https://rsdoctor.dev/
36+
937
## Contributing
1038

1139
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).

‎packages/sdk/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1-
# Rsdoctor
1+
# Rsdoctor SDK
22

3-
Rsdoctor is a tool for diagnosing and analyzing the build process and build artifacts to help developers quickly identify and solve problems.
3+
This package is the intermediate data layer of Rsdoctor.
44

5-
It also supports Webpack and Rspack builders, as well as various build frameworks, such as Rsbuild.
5+
## features
6+
7+
- Rsdoctor is a one-stop tool for diagnosing and analyzing the build process and build artifacts.
8+
- Rsdoctor is a tool that supports Webpack and Rspack build analysis.
9+
- Rsdoctor is an analysis tool that can display the time-consuming and behavioral details of the compilation.
10+
- Rsdoctor is a tool that provides bundle Diff and other anti-degradation capabilities simultaneously.
611

712
## Documentation
813

14+
https://rsdoctor.dev/
15+
916
## Contributing
1017

1118
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).

‎packages/test-helper/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
# Rsdoctor
22

3-
Rsdoctor is a tool for diagnosing and analyzing the build process and build artifacts to help developers quickly identify and solve problems.
3+
## features
44

5-
It also supports Webpack and Rspack builders, as well as various build frameworks, such as Rsbuild.
5+
- Rsdoctor is a one-stop tool for diagnosing and analyzing the build process and build artifacts.
6+
- Rsdoctor is a tool that supports Webpack and Rspack build analysis.
7+
- Rsdoctor is an analysis tool that can display the time-consuming and behavioral details of the compilation.
8+
- Rsdoctor is a tool that provides bundle Diff and other anti-degradation capabilities simultaneously.
69

710
## Documentation
811

12+
https://rsdoctor.dev/
13+
914
## Contributing
1015

1116
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).

‎packages/types/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1-
# Rsdoctor
1+
# Rsdoctor Types
22

3-
Rsdoctor is a tool for diagnosing and analyzing the build process and build artifacts to help developers quickly identify and solve problems.
3+
This package is the Rsdoctor‘s types package.
44

5-
It also supports Webpack and Rspack builders, as well as various build frameworks, such as Rsbuild.
5+
## features
6+
7+
- Rsdoctor is a one-stop tool for diagnosing and analyzing the build process and build artifacts.
8+
- Rsdoctor is a tool that supports Webpack and Rspack build analysis.
9+
- Rsdoctor is an analysis tool that can display the time-consuming and behavioral details of the compilation.
10+
- Rsdoctor is a tool that provides bundle Diff and other anti-degradation capabilities simultaneously.
611

712
## Documentation
813

14+
https://rsdoctor.dev/
15+
916
## Contributing
1017

1118
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).

‎packages/utils/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1-
# Rsdoctor
1+
# Rsdoctor Utils
22

3-
Rsdoctor is a tool for diagnosing and analyzing the build process and build artifacts to help developers quickly identify and solve problems.
3+
This package is the Rsdoctor‘s tools package.
44

5-
It also supports Webpack and Rspack builders, as well as various build frameworks, such as Rsbuild.
5+
## features
6+
7+
- Rsdoctor is a one-stop tool for diagnosing and analyzing the build process and build artifacts.
8+
- Rsdoctor is a tool that supports Webpack and Rspack build analysis.
9+
- Rsdoctor is an analysis tool that can display the time-consuming and behavioral details of the compilation.
10+
- Rsdoctor is a tool that provides bundle Diff and other anti-degradation capabilities simultaneously.
611

712
## Documentation
813

14+
https://rsdoctor.dev/
15+
916
## Contributing
1017

1118
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).

‎packages/webpack-plugin/README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,38 @@
1-
# Rsdoctor
1+
# Rsdoctor plugin
22

3-
Rsdoctor is a tool for diagnosing and analyzing the build process and build artifacts to help developers quickly identify and solve problems.
3+
This Rsdoctor plugin is an analysis plugin for the Webpack builder.
44

5-
It also supports Webpack and Rspack builders, as well as various build frameworks, such as Rsbuild.
5+
## features
6+
7+
- Rsdoctor is a one-stop tool for diagnosing and analyzing the build process and build artifacts.
8+
- Rsdoctor is a tool that supports Webpack and Rspack build analysis.
9+
- Rsdoctor is an analysis tool that can display the time-consuming and behavioral details of the compilation.
10+
- Rsdoctor is a tool that provides bundle Diff and other anti-degradation capabilities simultaneously.
11+
12+
## Note
13+
14+
This plugin is used by the `Webpack` repo to open Rsdoctor, [Quik Start](https://rsdoctor.dev/guide/start/quick-start).
15+
16+
Initialize the RsdoctorWebpackPlugin plugin in the [plugins](https://webpack.js.org/configuration/plugins/#plugins) section of the `webpack.config.js` file, as shown below:
17+
18+
```js title="webpack.config.js"
19+
const { RsdoctorWebpackPlugin } = require('@rsdoctor/webpack-plugin');
20+
21+
module.exports = {
22+
// ...
23+
plugins: [
24+
process.env.RSDOCTOR &&
25+
new RsdoctorWebpackPlugin({
26+
// options
27+
}),
28+
].filter(Boolean),
29+
};
30+
```
631

732
## Documentation
833

34+
https://rsdoctor.dev/
35+
936
## Contributing
1037

1138
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).

0 commit comments

Comments
 (0)