Skip to content

Commit

Permalink
Address Documentation Terminology and Typographical Corrections (#24)
Browse files Browse the repository at this point in the history
* Update README for improved terminology and clarity

- Changed "pull" to "merge" in the PR description for clearer understanding of the integration process.
- Replaced "includes" with "comprises" to use a more formal tone in describing the team composition.

* Fix typo in contribute.md

* Fix typo in xmtp-versions.md

* Fix typo in portable-inbox.md

* Fix typo for clarity in remote-attachment.mdx

* Fix typo in transaction-ref.mdx

* Fix typo in troubleshoot.md

* revert: fix spelling error in README.md
  • Loading branch information
Viktordgbpcv authored Aug 29, 2024
1 parent 7d475f9 commit ea0bd2c
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ And lastly, when contributing, please follow the XMTP community code of conduct

## Use the “Suggest changes to this page” link to submit a pull request

Using the **Suggest changes to this page** link provides a guided flow for editing content and submitting a PR using the GitHub UI in a web browser.
Using the **Suggest changes to this page** link provides a guided flow for editing content and submitting a PR using the GitHub UI in a web browser.

A PR is a request to add (or pull) your content updates into the project and publish them to the documentation on the site. After you submit a pull request, your proposed changes are publicly visible, meaning that anyone with a GitHub account can see them on GitHub.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/content-types/remote-attachment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ class Upload {
const upload = new Upload("uploadIdOfYourChoice", encryptedEncoded.payload);

const web3Storage = new Web3Storage({
token: "YOURTOKENHERE",
token: "YOUR-TOKEN-HERE",
});

const cid = await web3Storage.put([upload]);
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/content-types/transaction-ref.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ const transactionReference: TransactionReference = {
*/
namespace: "eip155";
/**
* The networkId for the transaction, in decimal or hexidecimal format
* The networkId for the transaction, in decimal or hexadecimal format
*/
networkId: 1;
/**
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/dms/troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ window.Buffer = window.Buffer ?? Buffer;

### On the first line of your main file, import `polyfills`

- ReacJS: `index.js` or `index.tsx`
- ReactJS: `index.js` or `index.tsx`
- VueJS: `main.js`
- NuxtJS: `app.vue`

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/protocol/portable-inbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "With XMTP, each user gets a portable inbox that provides access to

# XMTP portable inbox

With apps built with XMTP, each user gets a portable inbox. This inbox provides access to all of the XMTP messages you’ve exchanged, regardless of the app used to create the message. With your portable inbox, your essages meet you where you are.
With apps built with XMTP, each user gets a portable inbox. This inbox provides access to all of the XMTP messages you’ve exchanged, regardless of the app used to create the message. With your portable inbox, your messages meet you where you are.

For example, this means that you and a friend can each use your own preferred app to exchange messages.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/protocol/xmtp-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ To learn more about how XMTP V3 works, see the sections in [XMTP V3](/protocol/v

## XMTP V2

XMTP V2 supports one-to-one chat. One-to-one chat will eventually be available throught XMTP V3 and be built on MLS.
XMTP V2 supports one-to-one chat. One-to-one chat will eventually be available through XMTP V3 and be built on MLS.

The following XMTP SDKs support V2:

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/z_archive/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Request features by creating an issue in the [related XMTP GitHub repo](https://

We encourage pull requests (PRs) from the community, but we suggest that you start with a feature request or a post to the [XMTP Community Forums](https://community.xmtp.org/) just to do a temperature check. For example, if the PR involves a major change to the XMTP protocol, it must be fleshed out as an [XMTP Improvement Proposal](https://github.com/xmtp/XIPs/blob/main/XIPs/xip-0-purpose-process.md) before work begins.

If your PR to a repo in the [XMTP](https://github.com/xmtp) or [Ephemera](https://github.com/xmtp-labs) GitHub org is meerged you're eligible to claim this [XMTP contributor POAP](https://www.gitpoap.io/gp/1042).
If your PR to a repo in the [XMTP](https://github.com/xmtp) or [Ephemera](https://github.com/xmtp-labs) GitHub org is merged you're eligible to claim this [XMTP contributor POAP](https://www.gitpoap.io/gp/1042).

## XMTP Improvement Proposals

Expand Down

0 comments on commit ea0bd2c

Please sign in to comment.