From aaa4520642936477075c8450ea09d8244329d4e8 Mon Sep 17 00:00:00 2001 From: Tim McMackin Date: Thu, 12 Dec 2024 12:52:38 -0500 Subject: [PATCH] Typos (#457) * Comma typo * The binary tree layout is more efficient * Missing space * Complete sentence * This "also" is confusing * Flextesa is also... * Grammar * Broken root-relative link * Fix broken link --- docs/architecture/governance.md | 2 +- docs/dApps/taquito.md | 2 +- docs/developing/information/indexers.md | 2 +- docs/developing/sandbox.md | 4 ++-- docs/smart-contracts.mdx | 2 +- docs/smart-contracts/data-types/complex-data-types.md | 2 +- docs/tutorials/create-an-nft/nft-taquito.md | 2 +- docs/tutorials/join-dal-baker/prepare-account.md | 2 +- 8 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/architecture/governance.md b/docs/architecture/governance.md index 106f9cf5d..366af89e9 100644 --- a/docs/architecture/governance.md +++ b/docs/architecture/governance.md @@ -60,7 +60,7 @@ If not, it fails and a new Proposal period starts. The Cooldown period is a delay in the process that gives users time to review and test the new version of the protocol. The community sets up test networks that use the new version of the protocol. -Users verify that the protocol update works, see how their baking infrastructure works with it, and discusses the proposal. +Users verify that the protocol update works, see how their baking infrastructure works with it, and discuss the proposal. ### 4. Promotion period diff --git a/docs/dApps/taquito.md b/docs/dApps/taquito.md index b4fc0c321..604285052 100644 --- a/docs/dApps/taquito.md +++ b/docs/dApps/taquito.md @@ -42,7 +42,7 @@ npm install @taquito/taquito For tutorials that include using Taquito, see: -- [Build a simple web application](tutorials/build-your-first-app) +- [Build a simple web application](/tutorials/build-your-first-app) - [Create a contract and web app that mints NFTs](/tutorials/create-an-nft/nft-taquito) - [Mint NFTs from a web app](/tutorials/create-an-nft/nft-web-app) diff --git a/docs/developing/information/indexers.md b/docs/developing/information/indexers.md index 9da204a1b..3c78dfbfc 100644 --- a/docs/developing/information/indexers.md +++ b/docs/developing/information/indexers.md @@ -167,7 +167,7 @@ Many applications that work with on-chain data use an indexer. The simplest example of working with an indexer is a blockchain wallet. For example, to display a user's token balances, Temple Wallet queries data from the TzKT indexer and gets tokens' tickers and logos from the contract metadata. -You can do the same thing by calling the `GET tokens/balances` endpoint TzKT API and including your address as the value of the `account` parameter, as in this example: +You can do the same thing by calling the `GET tokens/balances` endpoint of the TzKT API and including your address as the value of the `account` parameter, as in this example: ``` https://api.tzkt.io/v1/tokens/balances?account=tz1UEQzJbuaGJgwvkekk6HwGwaKvjZ7rr9v4 diff --git a/docs/developing/sandbox.md b/docs/developing/sandbox.md index a8692bf5e..3b2a9eb2c 100644 --- a/docs/developing/sandbox.md +++ b/docs/developing/sandbox.md @@ -25,7 +25,7 @@ The Octez client sandboxed and mockup modes run a local version of the Tezos net ## Tezbox -[Tezbox](https://github.com/tez-capital/tezbox) is also a simulated Tezos environment that runs in a container. +[Tezbox](https://github.com/tez-capital/tezbox) is a simulated Tezos environment that runs in a container. Tezbox provides different images that mirror versions of the Octez suite. For example, to run Tezbox with Octez version 19.1 and the Paris protocol, run this command: @@ -49,7 +49,7 @@ Tezbox provides sample accounts in the `/tezbox/context/accounts.json` file. ## Flextesa -The [Flextesa](https://tezos.gitlab.io/flextesa/) is a simulated Tezos environment that runs in a container. +The [Flextesa](https://tezos.gitlab.io/flextesa/) is also a simulated Tezos environment that runs in a container. The Flextesa image has different scripts that start different versions of the Tezos protocol. For example, to start a Flextesa sandbox with the Oxford protocol, run this command: diff --git a/docs/smart-contracts.mdx b/docs/smart-contracts.mdx index 9178600c0..3d6deacce 100644 --- a/docs/smart-contracts.mdx +++ b/docs/smart-contracts.mdx @@ -24,7 +24,7 @@ For example, it is common to create financial instruments like various *tokens* In most cases, smart contracts remove intermediates and drastically reduce costs compared to classic paper contracts and their validations. -Notice that a smart contract can only run and interact with the blockchain it's stored on. It can't interact with the outside world. That's where *decentralized applications* or "dApps" come in ,because they provide interfaces for the outside world. +Notice that a smart contract can only run and interact with the blockchain it's stored on. It can't interact with the outside world. That's where *decentralized applications* or "dApps" come in, because they provide interfaces for the outside world. ## Components of a smart contract diff --git a/docs/smart-contracts/data-types/complex-data-types.md b/docs/smart-contracts/data-types/complex-data-types.md index 6fbabd909..e6484afae 100644 --- a/docs/smart-contracts/data-types/complex-data-types.md +++ b/docs/smart-contracts/data-types/complex-data-types.md @@ -56,7 +56,7 @@ In this layout, both sides of the main pair contain a pair, then both sides of t Here is an example of a binary tree: `{{-42; "Hello"}; {True; 21}}` -The binary tree layout is be more efficient than a right comb when accessing arbitrary elements. +The binary tree layout is more efficient than a right comb when accessing arbitrary elements. For example, to access the last element, you can get the second element of the main pair (`{True; 21}`) and the second element of that pair (`21`). If the tree is balanced, the number of operations to get to any element is $$O(\log_2 (size))$$, whereas for a right comb, it's $$O(size)$$. diff --git a/docs/tutorials/create-an-nft/nft-taquito.md b/docs/tutorials/create-an-nft/nft-taquito.md index e8bc8783d..cf5d110cf 100644 --- a/docs/tutorials/create-an-nft/nft-taquito.md +++ b/docs/tutorials/create-an-nft/nft-taquito.md @@ -18,7 +18,7 @@ In this tutorial, you will learn: :::note This tutorial covers both the backend and frontend parts of a dApp. -For a simpler tutorial that covers creating only the frontend application, see [Mint NFTs from a web app](tutorials/create-an-nft/nft-web-app). +For a simpler tutorial that covers creating only the frontend application, see [Mint NFTs from a web app](/tutorials/create-an-nft/nft-web-app). ::: diff --git a/docs/tutorials/join-dal-baker/prepare-account.md b/docs/tutorials/join-dal-baker/prepare-account.md index f81c20cc2..8a5cd5405 100644 --- a/docs/tutorials/join-dal-baker/prepare-account.md +++ b/docs/tutorials/join-dal-baker/prepare-account.md @@ -78,7 +78,7 @@ This command creates an account and associates it with the `my_baker` alias: octez-client register key my_baker as delegate ``` -1. Stake at least 6,000 tez, saving a small amount for transaction fees,by running this command: +1. Stake at least 6,000 tez, saving a small amount for transaction fees, by running this command: ```bash octez-client stake 6000 for my_baker