Skip to content

Commit 203b7e9

Browse files
authored
docs: unify title capitalization style (#8973)
* docs: unify title capitalization style * docs: update * fix * fix
1 parent 6c9d26e commit 203b7e9

File tree

102 files changed

+328
-333
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+328
-333
lines changed

CODE_OF_CONDUCT.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributor Covenant Code of Conduct
1+
# Contributor covenant code of conduct
22

3-
## Our Pledge
3+
## Our pledge
44

55
We as members, contributors, and leaders pledge to make participation in our
66
community a harassment-free experience for everyone, regardless of age, body
@@ -12,7 +12,7 @@ and orientation.
1212
We pledge to act and interact in ways that contribute to an open, welcoming,
1313
diverse, inclusive, and healthy community.
1414

15-
## Our Standards
15+
## Our standards
1616

1717
Examples of behavior that contributes to a positive environment for our
1818
community include:
@@ -36,7 +36,7 @@ Examples of unacceptable behavior include:
3636
- Other conduct which could reasonably be considered inappropriate in a
3737
professional setting
3838

39-
## Enforcement Responsibilities
39+
## Enforcement responsibilities
4040

4141
Community leaders are responsible for clarifying and enforcing our standards of
4242
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.
6565
All community leaders are obligated to respect the privacy and security of the
6666
reporter of any incident.
6767

68-
## Enforcement Guidelines
68+
## Enforcement guidelines
6969

7070
Community leaders will follow these Community Impact Guidelines in determining
7171
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
9191
like social media. Violating these terms may lead to a temporary or
9292
permanent ban.
9393

94-
### 3. Temporary Ban
94+
### 3. Temporary ban
9595

9696
**Community Impact**: A serious violation of community standards, including
9797
sustained inappropriate behavior.
@@ -102,7 +102,7 @@ private interaction with the people involved, including unsolicited interaction
102102
with those enforcing the Code of Conduct, is allowed during this period.
103103
Violating these terms may lead to a permanent ban.
104104

105-
### 4. Permanent Ban
105+
### 4. Permanent ban
106106

107107
**Community Impact**: Demonstrating a pattern of violation of community
108108
standards, including sustained inappropriate behavior, harassment of an

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Rspack Contributing Guide
1+
# Rspack contributing guide
22

33
Thank you for your interest in contributing to Rspack! There are many ways to contribute, and we appreciate all of them.
44

@@ -14,7 +14,7 @@ The Rspack team believe that creating a development guide for Rspack is a great
1414
By providing clarity and consistency, lowering barriers to entry, building trust, and encouraging collaboration,
1515
we can create a strong and thriving open source project that people will want to contribute to.
1616

17-
## Documentation Contribution
17+
## Documentation contribution
1818

1919
See [documentation](./website/README.md).
2020

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,17 @@ Rspack is a high performance JavaScript bundler written in Rust. It offers stron
2828

2929
Read [Introduction](https://rspack.dev/guide/start/introduction) for details.
3030

31-
## Getting Started
31+
## Getting started
3232

33-
See [Quick Start](https://rspack.dev/guide/start/quick-start).
33+
See [Quick start](https://rspack.dev/guide/start/quick-start).
3434

3535
## Contribution
3636

3737
Please read the [contributing guide](./CONTRIBUTING.md) and let's build Rspack together.
3838

39-
### Code of Conduct
39+
### Code of conduct
4040

41-
This repo has adopted the ByteDance Open Source Code of Conduct. Please check [Code of Conduct](./CODE_OF_CONDUCT.md) for more details.
41+
This repo has adopted the ByteDance Open Source Code of Conduct. Please check [Code of conduct](./CODE_OF_CONDUCT.md) for more details.
4242

4343
## Community
4444

website/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Rspack Documentation
1+
# Rspack documentation
22

33
📄 Documentation for Rspack.
44

@@ -21,7 +21,13 @@ The source code of Rspress can be found in [this folder](https://github.com/web-
2121

2222
If you have any problems using the Rspress, please create a new issue at [Rspress Issues](https://github.com/web-infra-dev/rspress/issues).
2323

24-
## Image Assets
24+
## Writing style guide
25+
26+
- **Capitalization style**: page titles and section headings should use sentence-style capitalization (only capitalize the first word and proper nouns) rather than title-style capitalization:
27+
- Correct: "A new method for creating JavaScript rollovers"
28+
- Incorrect: "A New Method for Creating JavaScript Rollovers"
29+
30+
## Image assets
2531

2632
For images you use in the document, it's better to upload them to the [rspack-contrib/rstack-design-resources](https://github.com/rspack-contrib/rstack-design-resources) repository, so the size of the current repository doesn't get too big.
2733

website/docs/en/api/cli.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Command Line Interface (CLI)
1+
# Command line interface (CLI)
22

33
[@rspack/cli](https://npmjs.com/package/@rspack/cli) provides two common subcommands, serve and build, to simplify daily work. If you do not have @rspack/cli installed, please read the [Quick Start](/guide/start/quick-start) section first.
44

website/docs/en/api/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The Command Line Interface (CLI) to configure and interact with your build. It i
1010

1111
## Runtime API
1212

13-
When processing modules with rspack, it is important to understand the different module syntaxes – specifically the methods and variables - that are supported. And also the runtime Hot Module Replacement (HMR) improves the development experience by updating modules in the browser at runtime without needing a whole page refresh.
13+
When processing modules with rspack, it is important to understand the different module syntaxes – specifically the methods and variables - that are supported. And also the runtime HMR improves the development experience by updating modules in the browser at runtime without needing a whole page refresh.
1414

1515
[Learn more about the Runtime API!](/api/runtime-api/module-methods)
1616

website/docs/en/api/loader-api/context.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import WebpackLicense from '@components/WebpackLicense';
22

33
<WebpackLicense from="https://webpack.js.org/api/loaders/#the-loader-context" />
44

5-
# The Loader Context
5+
# Loader context
66

77
The loader context represents the properties that are available inside of a loader assigned to the `this` property.
88

website/docs/en/api/loader-api/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Overview
22

3-
## Compatibility Status
3+
## Compatibility status
44

55
Rspack is committed to being compatible with the loaders within the webpack ecosystem. We ensure that Rspack is as compatible as possible with the webpack loader API, allowing more existing webpack loaders to be directly used in Rspack.
66

website/docs/en/api/plugin-api/compilation-hooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import Columns from '@components/Columns';
1111
import { NoSSR } from 'rspress/runtime';
1212
import { ApiMeta } from '@components/ApiMeta';
1313

14-
# Compilation Hooks
14+
# Compilation hooks
1515

1616
:::info
1717
The main compilation logic of Rspack runs on the Rust side. For factors such as stability, performance, and architecture, after the Rust side compilation objects are transferred to the JavaScript side when using hooks, the modifications on these objects will not be synchronized to the Rust side. Therefore, most of hooks are "read-only".

website/docs/en/api/plugin-api/compiler-hooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { Collapse, CollapsePanel } from '@components/Collapse';
66
import Columns from '@components/Columns';
77
import { NoSSR } from 'rspress/runtime';
88

9-
# Compiler Hooks
9+
# Compiler hooks
1010

1111
## Overview
1212

0 commit comments

Comments
 (0)