Skip to content

Commit 11d0b19

Browse files
committed
docs: Fix spelling mistakes
1 parent 754fea6 commit 11d0b19

10 files changed

Lines changed: 22 additions & 22 deletions

File tree

docs/architecture/design.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ sidebar_position: 2
55

66
# Nevermore design principles
77

8-
Nevermore consists of a few hundred packages in a [mono-repo](https://en.wikipedia.org/wiki/Monorepo). These packages are [semantically versioned](https://semver.org/) such that long-term maintaince can be done. Nevermore it trying to provide utility modules, and is not a framework.
8+
Nevermore consists of a few hundred packages in a [mono-repo](https://en.wikipedia.org/wiki/Monorepo). These packages are [semantically versioned](https://semver.org/) such that long-term maintenance can be done. Nevermore is trying to provide utility modules, and is not a framework.
99

10-
* **Lego blocks** - Nevermore provides utility modules that can combined in a variety of ways
10+
* **Lego blocks** - Nevermore provides utility modules that can be combined in a variety of ways
1111
* **Not a framework** - Nevermore works in a variety of other architectures
1212
* **Versioned** - Nevermore should be versioned. Nevermore should not break games when changes are made.
1313
* **Fast development** - Nevermore should accelerate game development
@@ -35,7 +35,7 @@ Library packages tend to be packages that export one or multiple libraries. Thes
3535
* [Elo](/api/EloUtils)
3636

3737
### Object utility libraries
38-
These are very similiar to libraries but they tend to export an object, and some supporting objects. These objects are concepts that are useful to learn, and generally exist outside of Roblox (although they may not). These are fundamental building blocks and patterns in Roblox.
38+
These are very similar to libraries but they tend to export an object, and some supporting objects. These objects are concepts that are useful to learn, and generally exist outside of Roblox (although they may not). These are fundamental building blocks and patterns in Roblox.
3939

4040
* [Octree](/api/Octree)
4141
* [Maid](/api/Maid)
@@ -45,7 +45,7 @@ These are very similiar to libraries but they tend to export an object, and some
4545
* [Queue](/api/Queue)
4646

4747
### Integration services
48-
There services are primary about providing a contract between two services.
48+
These services are primarily about providing a contract between two services.
4949

5050
* [GameConfigService](/api/GameConfigService)
5151
* [CameraStackService](/api/CameraStackService)
@@ -63,7 +63,7 @@ opinionated about...
6363
2. Consumption of code (plugin, game, et cetera)
6464

6565
Code is designed to be copied and pasted as needed, but first and foremost, is designed to empower James's (Quenty's) workflow. For this reason, while Nevermore tries its best to be useful
66-
to as wide of an audience as possible, in many ways document and design notes are lacking because this is not its first purpose.
66+
to as wide of an audience as possible, in many ways documentation and design notes are lacking because this is not its first purpose.
6767

6868

6969
## Loading system

docs/architecture/servicebag.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Services in Nevermore use [ServiceBag](/api/ServiceBag/) and need to be
99
required through them. ServiceBag provides services and helps with game or
1010
plugin initialization, and is like a `game` in Roblox. You can retrieve
1111
services from it, and it will ensure the service exists and is initialized.
12-
This will bootstrap any other dependent dependencies.
12+
This will bootstrap any other dependencies.
1313

1414
## tl;dr
1515

@@ -107,7 +107,7 @@ serviceBag:Start()
107107
:::warning
108108
An important detail of ServiceBag is that it does not allow your services to
109109
yield in the `:Init()` methods. This is to prevent a service from delaying your
110-
entires game start. If you need to yield, do work in `:Start()` or export your
110+
entire game start. If you need to yield, do work in `:Start()` or export your
111111
API calls as promises. See [Cmdr](/api/CmdrService/) for a good example of how
112112
this works.
113113
:::
@@ -205,7 +205,7 @@ end
205205

206206
## Extras
207207

208-
### Why is understanding ServiceBag is important?
208+
### Why is understanding ServiceBag important?
209209

210210
Nevermore tries to be a collection of libraries that can be plugged together,
211211
and not exist as a set framework that forces specific design decisions. While
@@ -244,7 +244,7 @@ and dependency injection system is a really good idea.
244244
### What ServiceBag tries to achieve
245245

246246
ServiceBag does service dependency injection and initialization. These words
247-
may be unfamiliar with you. Dependency injection is the process of retrieving
247+
may be unfamiliar to you. Dependency injection is the process of retrieving
248248
dependencies instead of constructing them in an object. Lifecycle management is
249249
the process of managing the life of services, which often includes the game.
250250

@@ -374,6 +374,6 @@ local function getAnyModule(module)
374374
end
375375
```
376376

377-
It's preferably your systems interop with ServiceBag directly as ServiceBag
377+
It's preferable that your systems interop with ServiceBag directly as ServiceBag
378378
provides more control, better testability, and more clarity on where things are
379379
coming from.

docs/build.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ In general you want to install the following by hand.
6464
2. [Git](https://git-scm.com/downloads)
6565
3. [Aftman](https://github.com/LPGhatguy/aftman)
6666

67-
After than you will want to clone Nevermore to a folder.
67+
After that you will want to clone Nevermore to a folder.
6868

6969
```bash
7070
git clone https://github.com/Quenty/NevermoreEngine.git
@@ -86,4 +86,4 @@ pnpm install
8686
You can then serve a test place
8787

8888
## Why does building need a custom version of Rojo?
89-
Nevermore does not need a custom version of Rojo to be consumed, but it does need one to be built. This custom version of Rojo understands symlinks and turn them into ObjectValues. These symlinks link the packages together and means that a change to a transient dependency, or direct dependency will immediately be shown in the upstream package.
89+
Nevermore does not need a custom version of Rojo to be consumed, but it does need one to be built. This custom version of Rojo understands symlinks and turn them into ObjectValues. These symlinks link the packages together and means that a change to a transitive dependency, or direct dependency will immediately be shown in the upstream package.

docs/ides/vscode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 1
55

66
# Getting started with VSCode
77

8-
VSCode works with Nevermore relatively easily. We have default extensions.json setup. Follow the general setup tips. These types should generally work for Cursor and other VS-Code based IDEs.
8+
VSCode works with Nevermore relatively easily. We have default extensions.json setup. Follow the general setup tips. These tips should generally work for Cursor and other VS-Code based IDEs.
99

1010
## Extensions
1111

@@ -22,7 +22,7 @@ These will provide snippets, styling, and linking.
2222

2323
You currently must use the forked version of luau-lsp. You can use the default extension.
2424

25-
in `settings.json` configure the luau-lsp server to point towards a custom exe path. This should be your Luau-lsp exe path installed via aftman.toml.
25+
In `settings.json`, configure the luau-lsp server to point towards a custom exe path. This should be your Luau-lsp exe path installed via aftman.toml.
2626

2727
```json
2828
"luau-lsp.server.path": "<path-to-aftman>/tool-storage/quenty/luau-lsp/<version>/luau-lsp.exe",

docs/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ npm install -g @quenty/nevermore-cli
3838
This will install the current version of Maid and all dependencies into the `node_modules` folder. To upgrade you will want to run `npm upgrade` You should ignore the `node_modules` folder in your source control system.
3939

4040
### What is NPM and why are we using it?
41-
[npm](https://www.npmjs.com/) is a package manager. Nevermore uses npm to manage package versions and install transient dependencies. A transient dependency is a dependency of a dependency (for example, [Blend](/api/Blend) depends upon [Maid](/api/Maid).
41+
[npm](https://www.npmjs.com/) is a package manager. Nevermore uses npm to manage package versions and install transitive dependencies. A transitive dependency is a dependency of a dependency (for example, [Blend](/api/Blend) depends upon [Maid](/api/Maid)).
4242

4343
### How do I install additional packages?
4444
The default installation comes with very few packages. This is normal. You can see which packages are installed by looking at the `package.json` file in a text editor. To install additional packages, simply run the following command in a terminal:
@@ -135,7 +135,7 @@ local require = require(loader).bootstrapGame(loader.Parent)
135135
Assuming you've changed nothing, the path to the replicated modules should be the same as the one used on the server, just indexed under ReplicatedStorage instead.
136136

137137
## Manually installing via NPM for a stand-alone module.
138-
If you want to use Nevermore for more stand-alone or reusable scenarios (where you can't assume that a packages folder will be reused, you can manually bootstrap the components using the loader system.
138+
If you want to use Nevermore for more stand-alone or reusable scenarios (where you can't assume that a packages folder will be reused), you can manually bootstrap the components using the loader system.
139139

140140
Ensure that you have [Node.js](https://nodejs.org/en/download/) v14+ installed on your computer.
141141

docs/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Nevermore has had significant cultural impact. There are some packages this repo
3131
* [DataStore](/api/DataStore) - Battle-tested datastore wrapper
3232
* [Camera](/api/CameraStackService) - Layered camera system that interops with Roblox's cameras
3333

34-
## Nevermore can by used in many cases
34+
## Nevermore can be used in many cases
3535
While Nevermore was originally designed to make games, in general Nevermore is now a collection of utility libraries that can be used in the following. These use cases have been carefully battle tested. Nevermore is in many top games, gamejams, plugins, and other components across Roblox.
3636

3737
* **Top Games** - Both built originally with Nevermore, or games that use other systems and frameworks but may want to include Nevermore

src/blend/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ npm install @quenty/blend --save
2222

2323
## Attributes
2424

25-
This system is designed to be very similar to fusion, except that we do not having any global state management, do not rely upon weak references, works with my types, and is built on top of Rx types.
25+
This system is designed to be very similar to fusion, except that we do not have any global state management, do not rely upon weak references, works with my types, and is built on top of Rx types.
2626

2727
* No global state
2828
* Extensible

src/brine/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</a>
1313
</div>
1414

15-
Fast and efficient extensible serialiation and deserialization library for Roblox with native instance support out of the box
15+
Fast and efficient extensible serialization and deserialization library for Roblox with native instance support out of the box
1616

1717
<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/BrineUtils">View docs →</a></div>
1818

src/camera/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ This class takes two arguments and returns the summation of the two
6868
* Arguments can be either `CameraState` or a CameraEffect, assuming the effect has a `CameraState` member
6969

7070
#### FadingCamera
71-
This classes allows the effects of a camera to be faded / varied based upon a spring
71+
This class allows the effects of a camera to be faded / varied based upon a spring
7272

7373
* Starts at 0 percent effect
7474

src/servicebag/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ npm install @quenty/servicebag --save
2424
- Remove requirement for many services to be loaded
2525
- Make installing new modules really easy
2626
- Make testing easier
27-
- Reduce maintaince costs
27+
- Reduce maintenance costs
2828
- Explicitly declare service pattern
2929
- Force declaration of service usage
3030
- Make it easy to trace service dependencies
@@ -82,7 +82,7 @@ function TestClass.new(serviceBag)
8282
self._serviceProvider = assert(serviceBag, "No serviceBag")
8383

8484
self._transparencyService = self._serviceProvider:GetRequiredService(TransparencyService)
85-
85+
8686
return self
8787
end
8888

0 commit comments

Comments
 (0)