fix: linting and spelling

oasisprotocol · Jan 6, 2025 · 45a52c7 · 45a52c7
1 parent 70d14c5
commit 45a52c7
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 126 deletions.
diff --git a/docs/README.mdx b/docs/README.mdx
@@ -19,6 +19,7 @@ crypto gaming
 ### Getting Started
 
 Develop and deploy a dApp on Sapphire:
+
 - follow along with a video walkthrough via [quickstart][quickstart]
 - start with a working dApp [demo][demo]
 - explore showcase dApps deployed on Sapphire on the [playground][playground]

diff --git a/docs/build/README.mdx b/docs/build/README.mdx
@@ -4,12 +4,12 @@ description: Build DApps on Sapphire
 
 # Build
 
-As Sapphire is EVM-compatible you can use the same dev-tooling as you would use
-building on Ethereum. Additional we build tools to support you the best on
-building secure and confidential DApps.
+As Sapphire is EVM-compatible, you can use the same dev tooling as you would
+when building on Ethereum. Additionally, we build tools to support you in
+creating secure and confidential DApps.
 
-Feel free to check out the [concept] page, to get a better understanding of the
-transaciton flow and the contract state.
+Feel free to check out the [concept] page to get a better understanding of the
+transaction flow and the contract state.
 
 [concept]: ./concept.mdx
 
@@ -33,10 +33,10 @@ You can find the details of the Oasis Sapphire Web3 endpoints
 ### Features
 
 - [Deployment and Proxies][deployment]
-- [Gasless and Onchain signing][gasless]
+- [Gasless and Onchain Signing][gasless]
 - [Security considerations][security]
 - [View-call authentication][view-call]
-- [Randomness, Subcalls and more precompiles][sapphire-contracts]
+- [Randomness, Subcalls and More Precompiles][sapphire-contracts]
 
 [deployment]: ./deployment.md
 [gasless]: ./gasless.md
@@ -46,7 +46,7 @@ You can find the details of the Oasis Sapphire Web3 endpoints
 
 ## Frontend Development
 
-We have support for the common frontend libraries
+We support the common frontend libraries:
 
 - [Ethers v6][ethers]
 - [Viem][viem]
@@ -65,7 +65,7 @@ If you want to connect and execute transactions from your backend, visit our
 
 ## Examples
 
-See our [examples] page for demo DApps that bring all the above together
+See our [examples] page for demo DApps that bring all the above together.
 
 [examples]: ../examples.mdx
 

diff --git a/docs/build/authentication.md b/docs/build/authentication.md
@@ -74,7 +74,7 @@ which created the contract, calling `isOwner` will return:
  * `false`, with `sapphire.wrap` but without an attached signer
  * `true`, with `sapphire.wrap` and an attached signer
  * `true`, if called via the contract which created it
-* `true`, if called via transaction
+ * `true`, if called via transaction
 
 ## Caching Signed Queries
 

diff --git a/docs/build/deployment.md b/docs/build/deployment.md
@@ -185,7 +185,7 @@ distinct and does not interfere with others. Namespacing is generally more
 robust and preferable to using `eth_getStorageAt`.
 
 See example ERC-7201 implementation and usage:
-https://gist.github.com/CedarMist/4cfb8f967714aa6862dd062742acbc7b
+<https://gist.github.com/CedarMist/4cfb8f967714aa6862dd062742acbc7b>
 
 ```solidity
 // SPDX-License-Identifier: Apache-2.0

diff --git a/docs/build/hardhat.md b/docs/build/hardhat.md
@@ -23,7 +23,7 @@ exploring Sapphire's privacy-preserving features.
 
 Check out the [Quickstart] to begin your journey!
 
-## Local development and testing
+## Local Development and Testing
 
 For local development and testing, Oasis provides a Docker container that
 simulates the Sapphire blockchain. This setup works similarly to the Hardhat
@@ -33,11 +33,12 @@ for fast, iterative development.
 To learn how to set up and use the local Sapphire environment, check out the
 [Localnet] chapter under the Tools section of the documentation. It provides
 detailed instructions on configuring and running the local blockchain, making
-it easy to test and debug your contracts before deploying them to a live network.
+it easy to test and debug your contracts before deploying them to a live
+network.
 
 ### Localnet Hardhat config
 
-To use the Localnet with hardhat, add the network as follows:
+To use the Localnet with Hardhat, add the network as follows:
 
 ```js title="hardhat.config.ts"
  import { HardhatUserConfig } from "hardhat/config";
@@ -67,17 +68,17 @@ const accounts = process.env.PRIVATE_KEY ? [process.env.PRIVATE_KEY] : TEST_HDWA
  };
 ```
 
-You can use now the standard test accounts to run your hardhat tests:
+You can now use the standard test accounts to run your Hardhat tests:
 
  ```shell
 npx hardhat test --network sapphire-localnet
 ```
 
 ## Hardhat Provider
 
-The `@oasisprotocol/sapphire-hardhat` package provides a custom Hardhat provider
-that enables encrypted transactions when working with Oasis Sapphire. This
-makes it easy to test and run tasks involving confidential smart contracts
+The `@oasisprotocol/sapphire-hardhat` package provides a custom Hardhat
+provider that enables encrypted transactions when working with Oasis Sapphire.
+This makes it easy to test and run tasks involving confidential smart contracts
 directly within your Hardhat setup.
 
 ### Installation

diff --git a/docs/examples.mdx b/docs/examples.mdx
@@ -14,9 +14,9 @@ description: Examples build with Sapphire
 
 ## Confidential Voting
 
-:::info [Example VoTEE][voting-example]
+:::info [Example VoTEE][votee-example]
 
-[Voting example][voting-example] to vote for the favorite Oasis mascot, see also [voTEE.oasis.io].
+[Voting example][votee-example] to vote for the favorite Oasis mascot, see also [voTEE.oasis.io].
 
 :::
 

diff --git a/docs/guide.mdx b/docs/guide.mdx
diff --git a/docs/network.mdx b/docs/network.mdx
@@ -73,7 +73,7 @@ dedicated RPC endpoints, consider the following providers (in alphabetic order):
 
 | Name (Provider)                               | Mainnet URL                                | Testnet URL                                | EIP-3091 compatible |
 |-----------------------------------------------|--------------------------------------------|--------------------------------------------|---------------------|
-| Oasis Explorer ([Oasis Protocol Foundation])  | https://explorer.oasis.io/mainnet/sapphire | https://explorer.oasis.io/testnet/sapphire | Yes                 |
+| Oasis Explorer ([Oasis Protocol Foundation])  | `https://explorer.oasis.io/mainnet/sapphire` | `https://explorer.oasis.io/testnet/sapphire` | Yes                 |
 | Oasis Scan ([Bit Cat])                        | [https://www.oasisscan.com/paratimes/000…279](https://www.oasisscan.com/paratimes/000000000000000000000000000000000000000000000000f80306c9858e7279) | [https://testnet.oasisscan.com/paratimes/000…f6c](https://testnet.oasisscan.com/paratimes/000000000000000000000000000000000000000000000000a6d1e3ebf60dff6c) | No |
 
 [Bit Cat]: https://www.bitcat365.com/