Skip to content

Commit eae3b16

Browse files
Jr-kennyjhaaaa
andauthored
fix(docs): correct typos, spacing, punctuation, and minor naming inconsistencies (#679)
* fix(docs): correct markdown spacing and punctuation in chat app guides * fix(docs): use correct verb form for set up * fix(docs): standardize SDK and repo naming in guides * fix(docs): revert sdk term change in stream guide --------- Co-authored-by: J-Ha <5481259+jhaaaa@users.noreply.github.com>
1 parent f2a7b34 commit eae3b16

File tree

7 files changed

+8
-8
lines changed

7 files changed

+8
-8
lines changed

docs/pages/agents/build-agents/create-a-client.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The XMTP Agent SDK allows you to use environment variables (`process.env`) for e
3333
| `XMTP_ENV` | XMTP network environment (`local`, `dev`, or `production`) | `XMTP_ENV=dev` or `XMTP_ENV=production` |
3434
| `XMTP_DB_ENCRYPTION_KEY` | Database encryption key for the local database (32 bytes, hex) | `XMTP_DB_ENCRYPTION_KEY=0xabcd...1234` |
3535

36-
Using the environment variables, you can setup your agent in just a few lines of code:
36+
Using the environment variables, you can set up your agent in just a few lines of code:
3737

3838
## Generate random keys
3939

docs/pages/agents/build-agents/groups.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Group chats can have metadata like names, descriptions, and images to help users identify them. You can set metadata when [creating a group chat](/agents/build-agents/create-conversations) or update it later.
44

55
:::tip[Quickstart]
6-
To learn more, see the [Gated group example](https://github.com/xmtplabs/xmtp-agent-examples/tree/main/examples/xmtp-gated-group) in the xmtp-agents-examples repo.
6+
To learn more, see the [Gated group example](https://github.com/xmtplabs/xmtp-agent-examples/tree/main/examples/xmtp-gated-group) in the xmtp-agent-examples repo.
77
:::
88

99
## Group metadata

docs/pages/agents/content-types/reactions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Use the reaction content type to support reactions with your agent. A reaction is a quick and often emoji-based way to respond to a message. Reactions are usually limited to a predefined set of emojis or symbols provided by the chat app.
44

55
:::tip[Quickstart]
6-
To learn more, see the [Reaction example](https://github.com/xmtplabs/xmtp-agent-examples/tree/main/examples/xmtp-thinking-reaction) in the xmtp-agents-examples repo.
6+
To learn more, see the [Reaction example](https://github.com/xmtplabs/xmtp-agent-examples/tree/main/examples/xmtp-thinking-reaction) in the xmtp-agent-examples repo.
77
:::
88

99
The reaction content type is built into the Agent SDK. No installation is required.

docs/pages/chat-apps/core-messaging/extend-id-model.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Every account on your target platform has a unique identifier (an address or pub
5959
You'll need to:
6060

6161
1. Define the new identifier kind in the [Rust identity module](https://github.com/xmtp/libxmtp/blob/main/crates/xmtp_id/src/associations/ident.rs) in the libxmtp repo.
62-
2. Add a new variant to the `MemberIdentifier` protobuf message. You can do this in [association.proto](https://github.com/xmtp/proto/blob/main/proto/identity/associations/association.proto). in the proto repo.
62+
2. Add a new variant to the `MemberIdentifier` protobuf message. You can do this in [association.proto](https://github.com/xmtp/proto/blob/main/proto/identity/associations/association.proto) in the proto repo.
6363

6464
### Implement signature verification
6565

@@ -95,4 +95,4 @@ Two-way associations are possible: A member of a conversation can see which addr
9595
| **Create a new inbox** |||||
9696
| **Add new installations to an inbox** |||||
9797
| **Add new identifiers to an inbox** |||||
98-
| **Act as recovery address** |||||
98+
| **Act as recovery address** |||||

docs/pages/chat-apps/core-messaging/group-permissions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Permissions are the actions a group chat participant can be allowed to take. The
3131
- Add a member to the group
3232
- Remove a member from the group
3333
- Update [group metadata](/chat-apps/core-messaging/group-metadata), such as group name, description, and image
34-
- Update group permissions on an item-by-item basis, such as calling `updateNamePermission` or `updateAddMemberPermission` . To learn more, see [Group.kt](https://github.com/xmtp/xmtp-android/blob/main/library/src/main/java/org/xmtp/android/library/Group.kt#L251-L313) in the xmtp-android SDK repo.
34+
- Update group permissions on an item-by-item basis, such as calling `updateNamePermission` or `updateAddMemberPermission`. To learn more, see [Group.kt](https://github.com/xmtp/xmtp-android/blob/main/library/src/main/java/org/xmtp/android/library/Group.kt#L251-L313) in the xmtp-android SDK repo.
3535

3636
The following permissions can be assigned by super admins only. This helps ensure that a “regular” admin cannot remove the super admin or otherwise destroy a group.
3737

docs/pages/chat-apps/push-notifs/pn-server.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ source .env
8484
./dev/run --xmtp-listener --api
8585
```
8686

87-
This starts both the `worker` and `api` services. The `worker` listens for new messages on the XMTP network and sends push notifications. The `api` service handles HTTP/GRPC requests.
87+
This starts both the `worker` and `api` services. The `worker` listens for new messages on the XMTP network and sends push notifications. The `api` service handles HTTP/gRPC requests.
8888

8989
![./dev/run --xmtp-listener --api in CLI](https://raw.githubusercontent.com/xmtp/docs-xmtp-org/main/docs/pages/img/cmd3.png)
9090

docs/pages/chat-apps/push-notifs/understand-push-notifs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ With XMTP, you can enable real-time push notifications to keep users updated on
44

55
At the highest level, push notifications with XMTP require these three elements:
66

7-
1. An **XMTP push notification server** that listens for all messages sent on the XMTP network. You set the server to listen to the`production`, `dev`, or `local` environment, and every message sent using that environment flows through the server. The server filters the messages accordingly and sends only the desired push notifications to a push notification service.
7+
1. An **XMTP push notification server** that listens for all messages sent on the XMTP network. You set the server to listen to the `production`, `dev`, or `local` environment, and every message sent using that environment flows through the server. The server filters the messages accordingly and sends only the desired push notifications to a push notification service.
88

99
2. A **push notification service**, such as Apple Push Notification service (APNs), Firebase Cloud Messaging (FCM), or W3C Web Push protocol, receives push notifications from the XMTP push notification server.
1010

0 commit comments

Comments
 (0)