From d9393d0d8ab888f4576e73d8fe32b36d2cd9d697 Mon Sep 17 00:00:00 2001 From: Nicolas Brugneaux Date: Thu, 16 May 2024 17:00:28 +0200 Subject: [PATCH] Docs typos 2 the electric boogaloo (#241) * chore: regenerate docs * fix: change the path of the docs diffing --- .github/workflows/ci.yml | 4 ++-- docs/command-line-interface/account.md | 10 +++++----- docs/command-line-interface/exchange.md | 2 +- docs/command-line-interface/network.md | 4 ++-- docs/command-line-interface/releasecelo.md | 6 +++--- docs/command-line-interface/transfer.md | 2 +- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2dcdc2b1e..673da782a 100644 --- 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 index a52e6b2ce..db963d79d 100644 --- 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 index bae093bf8..58d997630 100644 --- 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=