From dbc9becf4c143e8151b3513f71021f2bbbd87d8a Mon Sep 17 00:00:00 2001 From: Yash Jagtap Date: Sun, 22 Dec 2024 13:00:44 +0530 Subject: [PATCH] docs typos cleanup (#1456) --- .../pages/accounts/account-functions.adoc | 2 +- .../pages/network-architecture/block-structure.adoc | 2 +- .../pages/network-architecture/os.adoc | 4 ++-- .../Starknet/modules/quick-start/pages/environment-setup.adoc | 4 ++-- .../Starknet/modules/quick-start/pages/set-up-an-account.adoc | 2 +- .../Starknet/modules/quick-start/pages/using_devnet.adoc | 2 +- components/Starknet/modules/staking/pages/overview.adoc | 2 +- .../modules/starknet-versions/pages/juno-versions.adoc | 2 +- .../Starknet/modules/tools/pages/devtools/security.adoc | 2 +- contributing_to_docs/doc_guidelines.adoc | 2 +- 10 files changed, 12 insertions(+), 12 deletions(-) diff --git a/components/Starknet/modules/architecture-and-concepts/pages/accounts/account-functions.adoc b/components/Starknet/modules/architecture-and-concepts/pages/accounts/account-functions.adoc index 2a2f5a0612..8cb53180e7 100644 --- a/components/Starknet/modules/architecture-and-concepts/pages/accounts/account-functions.adoc +++ b/components/Starknet/modules/architecture-and-concepts/pages/accounts/account-functions.adoc @@ -40,7 +40,7 @@ That is, this function runs at most once throughout the lifecycle of the account When the sequencer receives a transaction, it calls the corresponding validation function with the appropriate input from the transaction's data, as follows: * For an `INVOKE` transaction, the sequencer calls the `+__validate__+` function with the transaction's calldata as input. The transaction's calldata will be deserialized to the arguments in the `+__validate__+` function's signature, it is up to the sender to make sure that the calldata is encoded appropriately according to validate's signature. After successfully completing validation, the sequencer calls the `+__execute__+` function with the same arguments. -* For a `DEPLOY_ACCOUNT` transaction, the sequencer calls the `constructor` function with the transaction's `constructor_calldata` as input (as above, it is expected that the constructor's calldata successfully desieralizes to the arguments in the constructor signature). After the successful execution of the constructor, the sequencer validates the transaction by calling the `+__validate_deploy__+` function. +* For a `DEPLOY_ACCOUNT` transaction, the sequencer calls the `constructor` function with the transaction's `constructor_calldata` as input (as above, it is expected that the constructor's calldata successfully deserializes to the arguments in the constructor signature). After the successful execution of the constructor, the sequencer validates the transaction by calling the `+__validate_deploy__+` function. * For a `DECLARE` transaction, the sequencer validates the transaction by calling the `+__validate_declare__+` function. * For more information on the available transaction types and their fields, see xref:architecture-and-concepts:network-architecture/transactions.adoc[Transaction types]. diff --git a/components/Starknet/modules/architecture-and-concepts/pages/network-architecture/block-structure.adoc b/components/Starknet/modules/architecture-and-concepts/pages/network-architecture/block-structure.adoc index c9c6d5d1f9..ad66062a2b 100644 --- a/components/Starknet/modules/architecture-and-concepts/pages/network-architecture/block-structure.adoc +++ b/components/Starknet/modules/architecture-and-concepts/pages/network-architecture/block-structure.adoc @@ -112,7 +112,7 @@ Where: The commitment to transactions, the commitment to events and the commitment to receipts are all roots of height-64 binary Merkle Patricia tries where the leaf at index `i` corresponds to: * For transactions: `h(transaction_hash, signature)` for the ``i``'th transaction included in the block, where `h` is the xref:../../cryptography/hash-functions.adoc#poseidon-hash[Poseidon hash function] -* For events: The xref:#event_hash[event hash] of the ``i``'th emitted evet included in the block +* For events: The xref:#event_hash[event hash] of the ``i``'th emitted event included in the block * For receipts: The xref:#receipt_hash[receipt hash] of the ``i``'th transaction receipt included in the block [#event_hash] diff --git a/components/Starknet/modules/architecture-and-concepts/pages/network-architecture/os.adoc b/components/Starknet/modules/architecture-and-concepts/pages/network-architecture/os.adoc index 45ec043bb7..949e9fe557 100644 --- a/components/Starknet/modules/architecture-and-concepts/pages/network-architecture/os.adoc +++ b/components/Starknet/modules/architecture-and-concepts/pages/network-architecture/os.adoc @@ -80,11 +80,11 @@ Finally, the Starknet Core contract is also responsible for verifying the few th == Implementations The Cairo code of SNOS is available in the https://github.com/starkware-libs/cairo-lang/tree/8e11b8cc65ae1d0959328b1b4a40b92df8b58595/src/starkware/starknet/core/os[cairo-lang GitHub repository^]. -However, this repository does not include all the hints implementiation, which are necessary to locally run SNOS. The current implementation of these hints in Python is now deprecated, and will no longer be maintained in future Starknet versions. +However, this repository does not include all the hints implementation, which are necessary to locally run SNOS. The current implementation of these hints in Python is now deprecated, and will no longer be maintained in future Starknet versions. [IMPORTANT] ==== -As part of the transition of Starknet's infrastructure to Rust, SNOS's Pythonic hints implementiation is deprecated, and will no longer be maintained in future Starknet versions. +As part of the transition of Starknet's infrastructure to Rust, SNOS's Pythonic hints implementation is deprecated, and will no longer be maintained in future Starknet versions. ==== Instead, a new Rust implementation of the hints, including initializing all inputs of SNOS via a Starknet full node connection, is available in the https://github.com/keep-starknet-strange/snos/tree/cb2a6d26faeb658492756fe100bbdf5b1600c768[SNOS GitHub repository^]. At the time of writing, this codebase supports the execution of SNOS for Starknet version 0.13.2. diff --git a/components/Starknet/modules/quick-start/pages/environment-setup.adoc b/components/Starknet/modules/quick-start/pages/environment-setup.adoc index d0af292296..5ab31d0982 100644 --- a/components/Starknet/modules/quick-start/pages/environment-setup.adoc +++ b/components/Starknet/modules/quick-start/pages/environment-setup.adoc @@ -36,7 +36,7 @@ curl https://get.starkli.sh | sh starkliup ---- -. Restart the terminal and verify that Starkli is installated correctly: +. Restart the terminal and verify that Starkli is installed correctly: + [source,shell] ---- @@ -56,7 +56,7 @@ Starknet Foundry's installation on Windows requires manually setting up shell co cargo install --locked --git https://github.com/xJonathanLEI/starkli ---- -. Restart the terminal and verify that Starkli is installated correctly: +. Restart the terminal and verify that Starkli is installed correctly: + [source,shell] ---- diff --git a/components/Starknet/modules/quick-start/pages/set-up-an-account.adoc b/components/Starknet/modules/quick-start/pages/set-up-an-account.adoc index f00d5ae05b..e9d106618d 100644 --- a/components/Starknet/modules/quick-start/pages/set-up-an-account.adoc +++ b/components/Starknet/modules/quick-start/pages/set-up-an-account.adoc @@ -171,7 +171,7 @@ The estimated account deployment fee is 0.000011483579723913 ETH. However, to av 0.000017225369585869 ETH to the following address: 0x01cf4d57ba01109f018dec3ea079a38fc08b789e03de4df937ddb9e8a0ff853a -Press [ENTER] once youve funded the address. +Press [ENTER] once you've funded the address. ---- You have now successfully deployed a new account to Starknet. diff --git a/components/Starknet/modules/quick-start/pages/using_devnet.adoc b/components/Starknet/modules/quick-start/pages/using_devnet.adoc index 54c325bc55..d348e07ff2 100644 --- a/components/Starknet/modules/quick-start/pages/using_devnet.adoc +++ b/components/Starknet/modules/quick-start/pages/using_devnet.adoc @@ -73,7 +73,7 @@ and create the corresponding keystore file by executing: starkli signer keystore from-key ~/.starkli-wallets/devnet/keystore.json ---- + -and entring `0xb137668388dbe9acdfa3bc734cc2c469` as private key (the same one as the one printed out by Devnet) +and entering `0xb137668388dbe9acdfa3bc734cc2c469` as private key (the same one as the one printed out by Devnet) . Now that you have an account set up, you can use Starkli to freely interact with Devnet. For example, you can redeploy Devnet's predeployed universal deployer using the following command: [source,bash] diff --git a/components/Starknet/modules/staking/pages/overview.adoc b/components/Starknet/modules/staking/pages/overview.adoc index aef5f26bc9..a8c8d2a584 100644 --- a/components/Starknet/modules/staking/pages/overview.adoc +++ b/components/Starknet/modules/staking/pages/overview.adoc @@ -148,5 +148,5 @@ Sepolia:: 0x03745ab04a431fc02871a139be6b93d9260b0ff3e779ad9c8b377183b23109f1 [NOTE] ==== -For developers who wish to dive deep, the index update interval parameter is set to a minimum of 1 minute in Starkent Sepolia and 30 minutes in Starknet mainnet. +For developers who wish to dive deep, the index update interval parameter is set to a minimum of 1 minute in Starknet Sepolia and 30 minutes in Starknet mainnet. ==== diff --git a/components/Starknet/modules/starknet-versions/pages/juno-versions.adoc b/components/Starknet/modules/starknet-versions/pages/juno-versions.adoc index ca77057817..ec1d159f23 100644 --- a/components/Starknet/modules/starknet-versions/pages/juno-versions.adoc +++ b/components/Starknet/modules/starknet-versions/pages/juno-versions.adoc @@ -257,7 +257,7 @@ This minor release introduces an important optimization that enhances sync perfo == https://github.com/NethermindEth/juno/releases/tag/v0.2.0[v0.2.0] -This release adds support for Staknet `v0.11.0`. +This release adds support for Starknet `v0.11.0`. WARNING: This release has breaking changes and database is not compatible with the previous version. diff --git a/components/Starknet/modules/tools/pages/devtools/security.adoc b/components/Starknet/modules/tools/pages/devtools/security.adoc index 7ae8ed72af..3277888ec6 100644 --- a/components/Starknet/modules/tools/pages/devtools/security.adoc +++ b/components/Starknet/modules/tools/pages/devtools/security.adoc @@ -6,7 +6,7 @@ Sierra-Analyzer is a security toolkit for analyzing Sierra files, developed by link:https://x.com/fuzzinglabs[FuzzingLabs]. -Supported featrued include: +Supported features include: * Decompile a Sierra file * Print the contracts Control Flow Graph diff --git a/contributing_to_docs/doc_guidelines.adoc b/contributing_to_docs/doc_guidelines.adoc index 11d3fefc4c..51e99b5076 100644 --- a/contributing_to_docs/doc_guidelines.adoc +++ b/contributing_to_docs/doc_guidelines.adoc @@ -533,7 +533,7 @@ root@17617744386d:/app# ./player.py ** link:https://docs.asciidoctor.org/asciidoc/latest/verbatim/source-blocks/[Source Code Blocks] ** link:https://docs.asciidoctor.org/asciidoc/latest/subs/[Substitutions] + -[CAUTIONI] +[CAUTION] ==== It can take some trial and error to figure out the correct source block macro to use for the exact markup you want to use. ====