Docs typos 2 the electric boogaloo (#241)

* chore: regenerate docs * fix: change the path of the docs diffing
celo-org · May 16, 2024 · d9393d0 · d9393d0
1 parent d05deab
commit d9393d0
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 14 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -288,8 +288,8 @@ jobs:
       - name: Fail if someone forgot to commit docs
         run: |
           yarn docs
-          if [[ $(git status packages/docs --porcelain) ]]; then
-            git --no-pager diff packages/docs
+          if [[ $(git status docs --porcelain) ]]; then
+            git --no-pager diff docs
             echo "There are git differences after generating all docs"
             git status
             git diff

diff --git a/docs/command-line-interface/account.md b/docs/command-line-interface/account.md
@@ -408,7 +408,7 @@ _See code: [src/commands/account/delete-payment-delegation.ts](https://github.co
 
 ## `celocli account:get-metadata ARG1`
 
-Show information about an address. Retreives the metadata URL for an account from the on-chain, then fetches the metadata file off-chain and verifies proofs as able.
+Show information about an address. Retrieves the metadata URL for an account from the on-chain, then fetches the metadata file off-chain and verifies proofs as able.
 
 ```
 USAGE
@@ -453,7 +453,7 @@ FLAGS
       property to sort by (prepend '-' for descending)
 
 DESCRIPTION
-  Show information about an address. Retreives the metadata URL for an account from the
+  Show information about an address. Retrieves the metadata URL for an account from the
   on-chain, then fetches the metadata file off-chain and verifies proofs as able.
 
 EXAMPLES
@@ -897,7 +897,7 @@ _See code: [src/commands/account/register-data-encryption-key.ts](https://github
 
 ## `celocli account:register-metadata`
 
-Register metadata URL for an account where users will be able to retieve the metadata file and verify your claims
+Register metadata URL for an account where users will be able to retrieve the metadata file and verify your claims
 
 ```
 USAGE
@@ -922,7 +922,7 @@ FLAGS
       Ignore metadata validity checks
 
   --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
-      (required) Addess of the account to set metadata for
+      (required) Address of the account to set metadata for
 
   --gasCurrency=0x1234567890123456789012345678901234567890
       Use a specific gas currency for transaction fees (defaults to CELO if no gas
@@ -948,7 +948,7 @@ FLAGS
       (required) The url to the metadata you want to register
 
 DESCRIPTION
-  Register metadata URL for an account where users will be able to retieve the metadata
+  Register metadata URL for an account where users will be able to retrieve the metadata
   file and verify your claims
 
 EXAMPLES

diff --git a/docs/command-line-interface/exchange.md b/docs/command-line-interface/exchange.md
@@ -218,7 +218,7 @@ FLAGS
   --globalHelp                                              View all available global
                                                             flags
   --stableToken=<option>                                    Name of the stable token to
-                                                            be transfered
+                                                            be transferred
                                                             <options: cUSD|cusd|cEUR|ceu
                                                             r|cREAL|creal>
   --value=10000000000000000000000                           (required) The value of

diff --git a/docs/command-line-interface/network.md b/docs/command-line-interface/network.md
@@ -10,7 +10,7 @@ View details about the network, like contracts and parameters
 
 ## `celocli network:contracts`
 
-Lists Celo core contracts and their addesses.
+Lists Celo core contracts and their addresses.
 
 ```
 USAGE
@@ -52,7 +52,7 @@ FLAGS
       property to sort by (prepend '-' for descending)
 
 DESCRIPTION
-  Lists Celo core contracts and their addesses.
+  Lists Celo core contracts and their addresses.
 ```
 
 _See code: [src/commands/network/contracts.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/network/contracts.ts)_

diff --git a/docs/command-line-interface/releasecelo.md b/docs/command-line-interface/releasecelo.md
@@ -148,7 +148,7 @@ _See code: [src/commands/releasecelo/locked-gold.ts](https://github.com/celo-org
 
 ## `celocli releasecelo:refund-and-finalize`
 
-Refund the given contract's balance to the appopriate parties and destroy the contact. Can only be called by the release owner of revocable ReleaseGold instances.
+Refund the given contract's balance to the appropriate parties and destroy the contact. Can only be called by the release owner of revocable ReleaseGold instances.
 
 ```
 USAGE
@@ -167,8 +167,8 @@ FLAGS
                                                             flags
 
 DESCRIPTION
-  Refund the given contract's balance to the appopriate parties and destroy the contact.
-  Can only be called by the release owner of revocable ReleaseGold instances.
+  Refund the given contract's balance to the appropriate parties and destroy the
+  contact. Can only be called by the release owner of revocable ReleaseGold instances.
 
 EXAMPLES
   refund-and-finalize --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631

diff --git a/docs/command-line-interface/transfer.md b/docs/command-line-interface/transfer.md
@@ -243,7 +243,7 @@ FLAGS
   --globalHelp                                              View all available global
                                                             flags
   --stableToken=<option>                                    Name of the stable to be
-                                                            transfered
+                                                            transferred
                                                             <options: cUSD|cusd|cEUR|ceu
                                                             r|cREAL|creal>
   --to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d           (required) Address of the