docs: unify title capitalization style (#702)

CODE_OF_CONDUCT.md

@@ -1,6 +1,6 @@
-# Contributor Covenant Code of Conduct
+# Contributor covenant code of conduct
 
-## Our Pledge
+## Our pledge
 
 We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
@@ -12,7 +12,7 @@ and orientation.
 We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
 
-## Our Standards
+## Our standards
 
 Examples of behavior that contributes to a positive environment for our
 community include:
@@ -36,7 +36,7 @@ Examples of unacceptable behavior include:
 - Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
-## Enforcement Responsibilities
+## Enforcement responsibilities
 
 Community leaders are responsible for clarifying and enforcing our standards of
 acceptable behavior and will take appropriate and fair corrective action in
@@ -65,7 +65,7 @@ All complaints will be reviewed and investigated promptly and fairly.
 All community leaders are obligated to respect the privacy and security of the
 reporter of any incident.
 
-## Enforcement Guidelines
+## Enforcement guidelines
 
 Community leaders will follow these Community Impact Guidelines in determining
 the consequences for any action they deem in violation of this Code of Conduct:
@@ -91,7 +91,7 @@ includes avoiding interactions in community spaces as well as external channels
 like social media. Violating these terms may lead to a temporary or
 permanent ban.
 
-### 3. Temporary Ban
+### 3. Temporary ban
 
 **Community Impact**: A serious violation of community standards, including
 sustained inappropriate behavior.
@@ -102,7 +102,7 @@ private interaction with the people involved, including unsolicited interaction
 with those enforcing the Code of Conduct, is allowed during this period.
 Violating these terms may lead to a permanent ban.
 
-### 4. Permanent Ban
+### 4. Permanent ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
 standards, including sustained inappropriate behavior, harassment of an

CONTRIBUTING.md

@@ -1,12 +1,12 @@
-# Rsdoctor Contribution Guide
+# Rsdoctor contribution guide
 
 Thanks for that you are interested in contributing to Rsdoctor. Before starting your contribution, please take a moment to read the following guidelines.
 
 ---
 
-## Setup the Environment
+## Setup the environment
 
-### Fork the Repo
+### Fork the repo
 
 [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your
 own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local.
@@ -54,7 +54,7 @@ What this will do:
 - Create symlinks between packages in the monorepo.
 - Run the `prepare` script to build all packages, powered by [nx](https://nx.dev/).
 
-### Set Git Email
+### Set git email
 
 Please make sure you have your email set up in `<https://github.com/settings/emails>`. This will be needed later when you want to submit a pull request.
 
@@ -78,19 +78,19 @@ git config user.email "SOME_EMAIL@example.com"
 
 ---
 
-## Making Changes and Building
+## Making changes and building
 
 Once you have set up the local development environment in your forked repo, we can start development.
 
-### Checkout A New Branch
+### Checkout a new branch
 
 It is recommended to develop on a new branch, as it will make things easier later when you submit a pull request:
 
 ```sh
 git checkout -b MY_BRANCH_NAME
 ```
 
-### Build the Package
+### Build the package
 
 Use [nx build](https://nx.dev/nx-api/nx/documents/run) to build the package you want to change:
 
@@ -106,7 +106,7 @@ pnpm run build
 
 ---
 
-## Startup Rsdoctor Client
+## Startup Rsdoctor client
 
 When you make changes to the code and want to view the `Rsdoctor` analysis report, you can execute `build:analysis` in the `examples/foo` project to see it:
 
@@ -121,13 +121,13 @@ pnpm run build:analysis
 
 ## Testing
 
-### Add New Tests
+### Add new tests
 
 If you've fixed a bug or added code that should be tested, then add some tests.
 
 You can add unit test cases in the `<PACKAGE_DIR>/tests` folder. The test syntax is based on [Vitest](https://vitest.dev/).
 
-### Run Unit Tests
+### Run unit tests
 
 Before submitting a pull request, it's important to make sure that the changes haven't introduced any regressions or bugs. You can run the unit tests for the project by executing the following command:
 
@@ -141,7 +141,7 @@ Alternatively, you can run the unit tests of single package using the `--filter`
 pnpm run --filter @rsdoctor/some-package test
 ```
 
-### Run E2E Tests
+### Run E2E tests
 
 In addition to the unit tests, the Rsdoctor also includes end-to-end (E2E) tests, which checks the functionality of the application as a whole.
 
@@ -180,9 +180,9 @@ This website is built with Rspress, the document content can be written using ma
 
 ---
 
-## Submitting Changes
+## Submitting changes
 
-### Committing your Changes
+### Committing your changes
 
 Commit your changes to your forked repo, and [create a pull request](https://help.github.com/articles/creating-a-pull-request/).
 

README.md

@@ -28,7 +28,7 @@ English | [简体中文](./README.zh-CN.md)
  <img src="https://github.com/web-infra-dev/rsdoctor/assets/18437716/4f28312a-68bf-4f9c-91cb-6fd603a37f53" alt="duplicate packages" />
 </div>
 
-## 📚 Getting Started
+## 📚 Getting started
 
 To get started with Rsdoctor, see the [Quick Start](https://rsdoctor.dev/guide/start/quick-start).
 
@@ -67,7 +67,7 @@ Come and chat with us on [Discord](https://discord.gg/wrBPBT6rkM)! The Rsdoctor
 - [Rspress](https://github.com/web-infra-dev/rspress): A fast Rspack-based static site generator.
 - [Modern.js](https://github.com/web-infra-dev/modern.js): A progressive React framework based on Rsbuild.
 
-## 🙌 Code of Conduct
+## 🙌 Code of conduct
 
 This repo has adopted the ByteDance Open Source Code of Conduct. Please check [Code of Conduct](./CODE_OF_CONDUCT.md) for more details.
 

e2e/README.md

@@ -2,18 +2,18 @@
 
 This folder contains the e2e test cases of Rsdoctor.
 
-## Tech Stack
+## Tech stack
 
 - [playwright](https://github.com/microsoft/playwright): The e2e test framework.
 
 ## Commands
 
 ```bash
-# Run all test cases, including Rspack and Webpack
+# Run all test cases, including Rspack and webpack
 pnpm run test
 ```
 
-## Add Test Cases
+## Add test cases
 
 ### Add test cases for common capabilities
 
@@ -25,4 +25,4 @@ import { expect, test } from '@playwright/test';
 test('test 1 + 1', () => {
   expect(1 + 1).toBe(2);
 });
-```
+```

packages/cli/README.md

@@ -1,4 +1,4 @@
-# Rsdoctor Cli
+# Rsdoctor CLI
 
 This is the cli package of Rsdoctor, you can use the capabilities of this package to open the analysis page without building.
 

packages/client/README.md

@@ -1,4 +1,4 @@
-# Rsdoctor Client
+# Rsdoctor client
 
 This package is the Rsdoctor reporting platform.
 

packages/components/README.md

@@ -1,4 +1,4 @@
-# Rsdoctor Components
+# Rsdoctor components
 
 This package is the Rsdoctor reporting platform’s components.
 

packages/core/README.md

@@ -1,4 +1,4 @@
-# Rsdoctor Core
+# Rsdoctor core
 
 This is the core package of Rsdoctor, providing core tools and analysis capabilities for Rsdoctor plugins.
 

packages/document/README.md

@@ -0,0 +1,5 @@
+# Rsdoctor Website
+
+## Writing style guide
+
+The same as Rspack: [Writing style guide](https://github.com/web-infra-dev/rspack/tree/main/website#writing-style-guide).

packages/document/docs/en/blog/release/release-note-0_1.mdx

@@ -1,4 +1,4 @@
-# Rsdoctor v0.1 Release Note
+# Rsdoctor v0.1 release note
 
 <picture>
   <img
@@ -42,11 +42,11 @@ Rsdoctor is a one-stop build analysis tool for Rspack and Webpack. It allows for
 
 ![Overall-Alerts](https://lf3-static.bytednsdoc.com/obj/eden-cn/lognuvj/rsdoctor/docs/start/overall-alerts.jpg)
 
-### ⭐️ Compilation Analysis
+### ⭐️ Compilation analysis
 
 Provides corresponding data and analysis functions for **Loaders, Plugins, and Module Resolve** to help you analyze problems in the compilation process.
 
-#### Loader Analysis
+#### Loader analysis
 
 - This module mainly provides the function of data analysis such as input and output, estimated time consumption, and parameters within **Rspack or Webpack Loaders**.
 
@@ -63,7 +63,7 @@ Provides corresponding data and analysis functions for **Loaders, Plugins, and M
   />
 </div>
 
-#### Plugin Analysis
+#### Plugin analysis
 
 - This module mainly intercepts and collects data information such as the number of calls and estimated time consumption of Plugins.
 
@@ -78,7 +78,7 @@ Provides corresponding data and analysis functions for **Loaders, Plugins, and M
   />
 </p>
 
-#### Resolve Analysis
+#### Resolve analysis
 
 - This module mainly provides path data and estimated time consumption for module resolution in a single file within the project. Rspack does not currently support this module.
 
@@ -93,7 +93,7 @@ Provides corresponding data and analysis functions for **Loaders, Plugins, and M
   />
 </p>
 
-### ⭐️ Product Analysis
+### ⭐️ Product analysis
 
 - In the **Bundle Size** page, we can see an overview of the product data information of the current project, as well as analyze the size and reasons for duplicate package imports.
 
@@ -110,11 +110,11 @@ Provides corresponding data and analysis functions for **Loaders, Plugins, and M
   />
 </p>
 
-## 📚 Quick Start
+## 📚 Quick start
 
 You can refer to the [Quick Start](https://rsdoctor.dev/guide/start/quick-start) to get started with **Rsdoctor**.
 
-## 💡 Next Steps
+## 💡 Next steps
 
 **Improve Rsdoctor build analysis efficiency**: Currently, enabling Rsdoctor plugin increases project build time. In the next step, we will extract and convert some of Rsdoctor's build analysis logic into a rust plugin, built-in to [Rspack](https://www.rspack.dev/), in order to improve Rsdoctor's build analysis efficiency.
 

packages/document/docs/en/blog/release/release-note-0_3.mdx

@@ -1,4 +1,4 @@
-# Rsdoctor v0.2-0.3 Release Note
+# Rsdoctor v0.2-0.3 release note
 
 Rsdoctor v0.3 has been released!
 
@@ -8,7 +8,7 @@ The new features of Rsdoctor v0.3 include:
 - Support for Banner Plugin: Added support for the Banner Plugin, which adds template wrapping to the bundled code, allowing analysis of code changes.
 - Support for ESM Loader Analysis: Added support for analyzing ESM Loaders in the compilation analysis in Rspack.
 
-## Custom Extension Rules
+## Custom extension rules
 
 Considering that users may have their own specific rule definition requirements, Rsdoctor provides an external interface for users to customize their own rule checks in addition to the internal rules already available.
 External extension interfaces need to be configured on the Rsdoctor plugin through the `extends` field, and their configurations are also placed in the `rules` field.
@@ -76,14 +76,14 @@ export default {
 };
 ```
 
-## Support for Banner Plugin
+## Support for banner plugin
 
 Both Rspack and Webpack support the BannerPlugin, which is an built-in plugin that allows you to add specific content at the top or bottom of the generated chunks. The added code will affect the parsing capability of the bundle.
 Therefore, Rsdoctor has added support for the Banner Plugin.
 
 Please refer to [Support for BannerPlugin](/guide/usage/bundle-size#support-for-bannerplugin)
 
-## Support for ESM Loader
+## Support for ESM loader
 
 Starting from Rspack@0.7.3, support for ESM Loader execution with `.js` extension and `type: module` configuration in `package.json` is added ([related issue](https://github.com/web-infra-dev/rspack/issues/5735)). Therefore, Rsdoctor also supports the analysis of ESM Loader, mainly supporting the following two types:
 
@@ -104,7 +104,7 @@ chain.plugin('Rsdoctor').use(RsdoctorRspackPlugin, [
 ]);
 ```
 
-## Support for Parse Bundle Configuration
+## Support for parse bundle configuration
 
 In some large repositories, the execution time for parsing bundles is significant. This is because the Parse Bundle analysis relies on AST parsing and processing, which can be time-consuming when there are a large number of files.
 If this capability is not necessary, it can be selectively disabled using the `supports.parseBundle` configuration. Here is an example:

packages/document/docs/en/blog/release/release-note-0_4.mdx

@@ -1,4 +1,4 @@
-# Rsdoctor v0.4 Release Note
+# Rsdoctor v0.4 release note
 
 Rsdoctor v0.4 is now released!
 
@@ -8,7 +8,7 @@ The new features of Rsdoctor v0.4 include:
 - **Bundle Diff**: Compare and analyze changes between two build artifacts.
 - **Vue Loader Analysis**: Added support for loader analysis in Vue projects.
 
-## Brief Mode
+## Brief mode
 
 In Rsdoctor v0.4, a new **Brief mode** has been added, designed specifically for CI/CD scenarios. Brief mode consolidates the data report into a single HTML page, making it convenient for users to view historical build data in CI/CD and other scenarios. The main features of Brief mode are:
 
@@ -18,7 +18,7 @@ In Rsdoctor v0.4, a new **Brief mode** has been added, designed specifically for
 
 This feature greatly enhances the convenience of using Rsdoctor analysis reports in CI processes. The report can be uploaded to a CDN in the pipeline to display historical reports. [For more details, please refer to](/guide/start/cicd)
 
-## Bundle Diff
+## Bundle diff
 
 import { Badge } from '@theme';
 
@@ -51,15 +51,15 @@ This feature enhances the user's ability to visually analyze changes in build ar
 
 Plans to support Bundle Diff Action on GitHub to simplify degradation monitoring during the CI phase.
 
-## Vue Loader Analysis
+## Vue loader analysis
 
 <Badge text="Version: 0.4.5" type="warning" />
 
 Support for loader analysis for Vue projects has been added in Rsdoctor v0.4.
 
 <img src="https://raw.githubusercontent.com/rspack-contrib/rstack-design-resources/d8074588e99dbdcaa278cd1e82f1298663e425db/others/assets/rsdoctor/vue-loader.png" />
 
-## Other Features
+## Other features
 
 - **Rspack's builtin:lightningcss-loader analysis**: Added support for [builtin:lightningcss-loader](https://rspack.dev/guide/features/builtin-lightningcss-loader#builtin-lightningcss-loader) analysis.
 - **Performance optimization**: