Skip to content

Commit c56ffa2

Browse files
committed
Improve English expressions in documentation
This commit improves awkward or non-native English expressions found throughout the project documentation to make them more natural for native English speakers. Main improvements: - Remove redundant words ("redundant boilerplate" → "boilerplate") - Fix superlative constructions ("the most oldest" → "the oldest") - Improve article usage ("few options" → "a few options") - Replace awkward phrases ("Special touch for" → "Enhanced") - Fix grammar patterns ("recommend you to" → "recommend that you") - Standardize terminology ("the Fediverse" → "the fediverse") - Remove unnecessary articles ("the most implementations" → "most") - Fix plural forms ("are a function" → "are functions") - Improve idiomatic expressions ("first of all" → "first") - Correct word order ("still is not aware" → "is still not aware") These changes were made after a comprehensive review of all major documentation files including README.md, AGENTS.md, CONTRIBUTING.md, and docs/ directory to identify and correct patterns that would sound awkward to native English speakers. [ci skip]
1 parent c276300 commit c56ffa2

File tree

7 files changed

+19
-19
lines changed

7 files changed

+19
-19
lines changed

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Project overview
1212

1313
Fedify is a TypeScript library for building federated server applications
1414
powered by ActivityPub and related standards, facilitating integration with
15-
the Fediverse. The project aims to eliminate complexity and boilerplate code
15+
the fediverse. The project aims to eliminate complexity and boilerplate code
1616
when implementing federation protocols.
1717

1818
Main features:

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ A patch set should include the following:
141141
- The *CHANGES.md* entry. The entry should include the issue number,
142142
the pull request number, and your name (unless you want to be anonymous).
143143

144-
Bug fix pull requests should target the most oldest maintenance branch that
144+
Bug fix pull requests should target the oldest maintenance branch that
145145
the bug affects. If you are not sure which branch to target, please ask in the
146146
issue tracker.
147147

@@ -400,7 +400,7 @@ code .
400400
> ~~~~
401401
402402
Note that the `mise run codegen` command is required to run only once at
403-
very first time, or when you update the code generation scripts. Otherwise,
403+
the very first time, or when you update the code generation scripts. Otherwise,
404404
you can skip the command and just run:
405405
406406
~~~~ bash

docs/intro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ What is Fedify?
33

44
Fedify is a TypeScript library for building federated server apps
55
powered by [ActivityPub] and other standards, so-called [fediverse].[^1]
6-
It aims to eliminate the complexity and redundant boilerplate code when
6+
It aims to eliminate the complexity and boilerplate code when
77
building a federated server app, so that you can focus on your business logic
88
and user experience.
99

@@ -16,8 +16,8 @@ Currently, Fedify provides the following features out of the box:
1616
- [Object Integrity Proofs][FEP-8b32] & [Linked Data Signatures]
1717
- Middlewares for handling webhooks
1818
- [NodeInfo] protocol
19-
- Special touch for interoperability with Mastodon and few other popular
20-
fediverse software
19+
- Enhanced interoperability with Mastodon and other popular fediverse
20+
software
2121
- [Integration with various web frameworks](./manual/integration.md)
2222
- [CLI toolchain for testing and debugging](./cli.md)
2323

docs/manual/actor.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Actor dispatcher
1111
In ActivityPub, [actors] are entities that can perform [activities]. You can
1212
register an actor dispatcher so that Fedify can dispatch an appropriate actor
1313
by its identifier. Since the actor dispatcher is the most significant part of
14-
the Fedify, it is the first thing you need to do to make Fedify work.
14+
Fedify, it is the first thing you need to do to make Fedify work.
1515

1616
An actor dispatcher is a callback function that takes a `Context` object and
1717
an identifier, and returns an actor object. The actor object can be one of
@@ -129,7 +129,7 @@ details.
129129
Key properties of an `Actor`
130130
----------------------------
131131

132-
Despite ActivityPub declares every property of an actor as optional,
132+
Although ActivityPub declares every property of an actor as optional,
133133
in practice, you need to set some of them to make the actor work properly
134134
with the existing ActivityPub implementations. The following shows
135135
the key properties of an `Actor` object:
@@ -217,7 +217,7 @@ a `CryptographicKey` instance. This property is usually used for verifying
217217
See the [next section](#public-keys-of-an-actor) for details.
218218

219219
> [!TIP]
220-
> In theory, an actor has multiple `publicKeys`, but in practice, the most
220+
> In theory, an actor has multiple `publicKeys`, but in practice, most
221221
> implementations have trouble with multiple keys. Therefore, it is recommended
222222
> to set only one key in the `publicKey` property. Usually, it contains
223223
> the first RSA-PKCS#1-v1.5 public key of the actor.
@@ -481,7 +481,7 @@ to let users change their WebFinger username without breaking the existing
481481
network, because changing the WebFinger username does not affect the actor URI.
482482

483483
> [!NOTE]
484-
> We highly recommend you to set the actor's `preferredUsername` property to
484+
> We highly recommend that you set the actor's `preferredUsername` property to
485485
> the corresponding WebFinger username so that peers can find the actor's
486486
> fediverse handle by fetching the actor object.
487487

docs/manual/log.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ properties:
357357
the `messageId` property is included in it. The `messageId` is a unique
358358
identifier for the background task, which is a UUID.
359359

360-
When you want to trace log messages, first of all you need to use a sink that
360+
When you want to trace log messages, first you need to use a sink that
361361
writes log messages as structured data. For example, you can use
362362
a [file sink] with a [JSON Lines] formatter. Oh, and don't forget to set
363363
`contextLocalStorage` in [`configure()`]! To sum up, you can configure

docs/tutorial/basics.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ Now, open your web browser and navigate to <http://localhost:8000/>. You should
218218
see the <q>Hello, world</q> message.
219219

220220
As you can guess, [`Deno.serve()`] (in case of Deno), [`Bun.serve()`] (in case
221-
of Bun), and [`serve()`] (in case of Node.js) are a function to create an HTTP
221+
of Bun), and [`serve()`] (in case of Node.js) are functions to create an HTTP
222222
server. They take a callback function that receives a [`Request`] object and
223223
returns a [`Response`] object. The `Response` object is sent back to the client.
224224

@@ -305,7 +305,7 @@ serve({
305305

306306
:::
307307

308-
The `Federation.fetch()` method takes the incoming `Request` and few options.
308+
The `Federation.fetch()` method takes the incoming `Request` and a few options.
309309
In this case, we pass `undefined` as the `contextData` because we don't
310310
need to share any context data here.
311311

@@ -613,7 +613,7 @@ Press ^C to close the tunnel.
613613
> time you restart the command.
614614
615615
However, since `fedify tunnel` is a reverse proxy between the public internet
616-
and your server, the server still is not aware the fact that it is exposed to
616+
and your server, the server is still not aware of the fact that it is exposed to
617617
the public internet through HTTPS. In order to make the server aware of it,
618618
you need to place a [x-forwarded-fetch] middleware in front of the `Federation`.
619619
@@ -728,7 +728,7 @@ In ActivityPub, an [inbox] is where an actor receives incoming activities from
728728
other actors. To accept follow requests from other servers, we need to register
729729
an inbox listener for the actor *me*.
730730
731-
Let's register an inbox listener for the actor *me*. First of all, every
731+
Let's register an inbox listener for the actor *me*. First, every
732732
activity is represented as a class in the Fedify framework. The `Follow` class
733733
represents the `Follow` activity. We will use the `Follow` class to handle
734734
incoming follow requests:

packages/fedify/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
1616
Fedify is a TypeScript library for building federated server apps
1717
powered by [ActivityPub] and other standards, so-called [fediverse].[^1]
18-
It aims to eliminate the complexity and redundant boilerplate code when
18+
It aims to eliminate the complexity and boilerplate code when
1919
building a federated server app, so that you can focus on your business logic
2020
and user experience.
2121

@@ -28,8 +28,8 @@ Currently, Fedify provides the following features out of the box:
2828
- [Object Integrity Proofs][FEP-8b32] & [Linked Data Signatures]
2929
- Middlewares for handling webhooks
3030
- [NodeInfo] protocol
31-
- Special touch for interoperability with Mastodon and few other popular
32-
fediverse software
31+
- Enhanced interoperability with Mastodon and other popular fediverse
32+
software
3333
- Integration with various web frameworks
3434
- CLI toolchain for testing and debugging
3535

@@ -89,7 +89,7 @@ Packages
8989
--------
9090

9191
Fedify is a monorepo that contains several packages, each of which provides
92-
different features and functionalities. The main package is *@fedify/fedify*,
92+
different features. The main package is *@fedify/fedify*,
9393
which provides the core functionality of the framework. Other packages provide
9494
integrations with various web frameworks, database drivers, and other features.
9595
Here is the list of packages:

0 commit comments

Comments
 (0)