Skip to content

Commit f0ff737

Browse files
committed
docs: improve clarity and conciseness across various documentation files.
1 parent cf3e03e commit f0ff737

File tree

6 files changed

+29
-33
lines changed

6 files changed

+29
-33
lines changed

CODE_OF_CONDUCT.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
# Contributor Covenant Code of Conduct
22

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

5-
We as members, contributors, and leaders pledge to make participation in our
5+
Members, contributors, and leaders pledge to make participation in the
66
community a harassment-free experience for everyone, regardless of age, body
77
size, visible or invisible disability, ethnicity, sex characteristics, gender
88
identity and expression, level of experience, education, socio-economic status,
99
nationality, personal appearance, race, religion, or sexual identity
1010
and orientation.
1111

12-
We pledge to act and interact in ways that contribute to an open, welcoming,
12+
The pledge is to act and interact in ways that contribute to an open, welcoming,
1313
diverse, inclusive, and healthy community.
1414

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

1717
Examples of behavior that contributes to a positive environment for our
1818
community include:
1919

2020
- Demonstrating empathy and kindness toward other people
2121
- Being respectful of differing opinions, viewpoints, and experiences
2222
- Giving and gracefully accepting constructive feedback
23-
- Accepting responsibility and apologizing to those affected by our mistakes,
23+
- Accepting responsibility and apologizing to those affected by mistakes,
2424
and learning from the experience
25-
- Focusing on what is best not just for us as individuals, but for the
25+
- Focusing on what is best not just for individuals, but for the
2626
overall community
2727

2828
Examples of unacceptable behavior include:
@@ -38,7 +38,7 @@ Examples of unacceptable behavior include:
3838

3939
## Enforcement Responsibilities
4040

41-
Community leaders are responsible for clarifying and enforcing our standards of
41+
Community leaders are responsible for clarifying and enforcing standards of
4242
acceptable behavior and will take appropriate and fair corrective action in
4343
response to any behavior that they deem inappropriate, threatening, offensive,
4444
or harmful.
@@ -52,15 +52,14 @@ 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 the community include using an official e-mail address,
5656
posting via an official social media account, or acting as an appointed
5757
representative at an online or offline event.
5858

5959
## Enforcement
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement by contacting the maintainer team
63-
.
62+
reported to community leaders responsible for enforcement by contacting the maintainer.
6463
All complaints will be reviewed and investigated promptly and fairly.
6564

6665
All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Developer's Guide
22

3-
Hey there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great and we truly appreciate your time and effort.
3+
Hey there! Contributing to this project is highly encouraged. Community help is essential for maintaining its quality, and every effort is appreciated.
44

55
> [!IMPORTANT]
66
> Before submitting your contribution, please take a moment and read through the following guidelines.
@@ -27,7 +27,7 @@ Build the project for production. The result is under `dist/`.
2727

2828
### `bun check`
2929

30-
We use [Biome](https://biomejs.dev/) for **both linting and formatting**. It is an ultra-fast, Rust based linter and formatter.
30+
Biome is used for **both linting and formatting**. It is an ultra-fast, Rust based linter and formatter.
3131
It also lints JSON.
3232

3333
You can also run `bun fix` to apply any safe fixes automatically.
@@ -54,7 +54,7 @@ For typo fixes, it's recommended to batch multiple typo fixes into one pull requ
5454

5555
### Pull Request
5656

57-
If you don't know how to send a Pull Request, we recommend reading [the guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
57+
If you don't know how to send a Pull Request, it is recommended to read [the guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
5858

5959
If your PR fixes or resolves an existing issue, please add the following line in your PR description according to the following example:
6060

@@ -75,19 +75,19 @@ Replacing:
7575

7676
This will let GitHub know the issues are linked, and automatically close them once the PR gets merged. Learn more at [the guide](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
7777

78-
It's ok to have multiple commits in a single PR, you don't need to rebase or force push for your changes as we will use `Squash and Merge` to squash the commits into one commit when merging.
78+
It's ok to have multiple commits in a single PR; changes do not need to be rebased or force pushed, as Squash and Merge will be used to combine the commits into one when merging.
7979

8080
## 📖 References
8181

8282
### Lint
8383

84-
We use [Biome](https://biomejs.dev/) for both linting and formatting with [a few custom rules](./biome.jsonc). It is an ultra-fast, Rust based linter and formatter.
84+
Biome is used for both linting and formatting with [a few custom rules](./biome.jsonc). It is an ultra-fast, Rust based linter and formatter.
8585

8686
<table><tr><td>
8787

8888
#### IDE Setup
8989

90-
We recommend using [VS Code](https://code.visualstudio.com/) along with:
90+
[Visual Studio Code](https://code.visualstudio.com/) is recommended for the best experience along with:
9191
- [Biome extension](https://marketplace.visualstudio.com/items?itemName=biomejs.biome) for linting and formatting.
9292
- [ArkType extension](https://marketplace.visualstudio.com/items?itemName=arktypeio.arkdark) for syntax highlighting and type-safe regex support.
9393

README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@
1212
</div>
1313

1414
> [!TIP]
15-
> **New!** Our Prisma-based alternative to Bedstack was just approved on CodebaseShow. Check it out: [Bepstack](https://github.com/bedtime-coders/bepstack)
16-
17-
> [!TIP]
18-
> **New!** We've added support for [Drizzle v1 Beta](https://orm.drizzle.team/roadmap) in _Bedstack (Stripped)_. Check it out: [`drizzle-v1` branch](https://github.com/bedtime-coders/bedstack-stripped/tree/drizzle-v1)
15+
> ⚡ We support [Drizzle v1 Beta](https://orm.drizzle.team/roadmap)! Check it out: [`drizzle-v1` branch](https://github.com/bedtime-coders/bedstack-stripped/tree/drizzle-v1)
1916
2017
<br/>
2118
<br/>

SUPPORT.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ This article explains where to get help with Bedstack.
44
Please read through the following guidelines.
55

66
> [!WARNING]
7-
> Before participating in our community, please read our
7+
> Before participating in the community, please read the
88
> [code of conduct](CODE_OF_CONDUCT.md).
99
> By interacting with this repository, organization, or community you agree to
1010
> abide by its terms.
1111
1212
## Asking quality questions
1313

14-
Questions can go to our [Discord server](https://discord.gg/8UcP9QB5AV) or [GitHub discussions](https://github.com/bedtime-coders/bedstack/discussions).
14+
Questions can go to the [Discord server](https://discord.gg/8UcP9QB5AV) or [GitHub discussions](https://github.com/bedtime-coders/bedstack/discussions).
1515

16-
Help us help you!
16+
Clear questions are easier to answer.
1717
Spend time framing questions and add links and resources.
1818
Spending the extra time up front can help save everyone time in the long run.
1919
Here are some tips:
@@ -29,7 +29,7 @@ Here are some tips:
2929
* Provide sample code, such as a [CodeSandbox](https://codesandbox.io/) or video, if possible
3030
* Screenshots can help, but if there’s important text such as code or error
3131
messages in them, please also provide those as text
32-
* The more time you put into asking your question, the better we can help you
32+
* The more time put into asking a question, the better the community can provide assistance
3333

3434
## Contributions
3535

apps/www/getting-started.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting Started
22

3-
Getting started with this RealWorld project is as easy as installing a few prerequisites, running a few commands, and opening your favorite text editor. We'd love to have you [contribute](https://github.com/bedtime-coders/bedstack/blob/main/CONTRIBUTING.md) to this project. If you have any questions, please reach out on [Discord](https://discord.gg/8UcP9QB5AV) or [GitHub Discussions](
3+
Getting started with this RealWorld project is as easy as installing a few prerequisites, running a few commands, and opening your favorite text editor. [Contributions](https://github.com/bedtime-coders/bedstack/blob/main/CONTRIBUTING.md) are welcome. If you have any questions, please reach out on [Discord](https://discord.gg/8UcP9QB5AV) or [GitHub Discussions](
44
https://github.com/bedtime-coders/bedstack/discussions
55
)!
66

@@ -11,7 +11,7 @@ Getting started with this RealWorld project is as easy as installing a few prere
1111
- [Bun](https://bun.com/) version 1.0.6 or higher.
1212
- Terminal for accessing Bun via its command-line interface (CLI).
1313
- Text Editor with TypeScript support.
14-
- We recommend [Visual Studio Code](https://code.visualstudio.com/); other IDEs have been reported to cause issues with ElysiaJS's type inference system.
14+
- [Visual Studio Code](https://code.visualstudio.com/) is recommended for the best experience; other IDEs have been reported to cause issues with ElysiaJS's type inference system.
1515

1616
### Setup
1717

@@ -43,7 +43,7 @@ $ bun dev
4343

4444
## What's Next?
4545

46-
* Once you're ready to contribute, check out our [contributing guide](https://github.com/bedtime-coders/bedstack/blob/main/CONTRIBUTING.md). We're excited to have you!
47-
* If you're looking for a place to start, check out our [good first issues](https://github.com/bedtime-coders/bedstack/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
48-
* If you need support, check out our [support page](https://github.com/bedtime-coders/bedstack/blob/main/SUPPORT.md).
49-
* If you have any questions or just want to chat, join our [Discord server](https://discord.gg/8UcP9QB5AV) or [GitHub Discussions](https://github.com/bedtime-coders/bedstack/discussions).
46+
* To contribute, see the [contributing guide](https://github.com/bedtime-coders/bedstack/blob/main/CONTRIBUTING.md).
47+
* For a place to start, see the [good first issues](https://github.com/bedtime-coders/bedstack/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
48+
* For support, visit the [support page](https://github.com/bedtime-coders/bedstack/blob/main/SUPPORT.md).
49+
* To ask questions or chat, join the [Discord server](https://discord.gg/8UcP9QB5AV) or [GitHub Discussions](https://github.com/bedtime-coders/bedstack/discussions).

apps/www/what-is-bedstack.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This [repository](https://github.com/bedtime-coders/bedstack) implements the Rea
88

99
## Core technologies
1010

11-
We carefully chose some of the latest and greatest technologies from the bleeding edge that share our core philosophy. They are:
11+
The selected technologies share Bedstack's core philosophy. They are:
1212

1313
- **[Bun](https://bun.com/)** - All-in-one JavaScript runtime & toolkit designed for speed, complete with a bundler, test runner, and Node.js-compatible package manager.
1414

@@ -33,14 +33,14 @@ For **experienced developers**, RealWorld is a practical benchmark. It is a stru
3333

3434
## Why Bun, ElysiaJS, Drizzle, or any of the core technologies?
3535

36-
When [Bun](https://bun.com/) was announced, it promised a simpler and more unified approach to modern TypeScript development. Instead of evaluating it in isolation, we chose to test it under real conditions.
36+
When [Bun](https://bun.com/) was announced, it promised a simpler and more unified approach to modern TypeScript development. It was tested under real conditions.
3737

3838
The question was simple:
3939

4040
> What better way to evaluate a new runtime than to build a full RealWorld backend with it?
4141
4242
ElysiaJS, Drizzle, and ArkType were selected because they are designed with Bun and TypeScript-first development in mind, and because they reinforce the same core values.
4343

44-
Bedstack is unapologetically opinionated. A tech stack is not a menu of options, it is a curated path to correct decisions. ArkType was chosen because it offers excellent type inference and makes the correct choice the easiest choice.
44+
Bedstack is unapologetically opinionated. A tech stack is not a menu of options, it is a curated path to correct decisions. ArkType offers excellent type inference and makes the correct choice the easiest choice.
4545

4646
That said, Bedstack relies on the [Standard Schema](https://github.com/standard-schema/standard-schema) interface. Advanced users can substitute another compliant validator if needed, but ArkType remains the recommended and supported path.

0 commit comments

Comments
 (0)