Fix typos and grammatical errors across multiple documentation files #470

Dimitrolito · 2024-12-06T16:09:45Z

This pull request fixes several typographical and grammatical issues across various documentation files in the project. Changes include the correction of articles ("a" vs. "an") and clarification of phrases for improved readability and accuracy.

Motivation and Context:

These changes were made to address typos and ensure consistency in grammar, which helps improve the clarity and professionalism of the documentation. Some issues included the incorrect use of articles and repetitive phrases, which could confuse readers.

Changes:

Fixed the use of "a" vs. "an" where appropriate (e.g., "a Uniswap V3 Pool" → "an Uniswap V3 Pool").
Removed repetitive phrases (e.g., "when users when users" → "when users").
Corrected other minor typographical errors for clarity.

Impact:

These changes are purely grammatical and will not affect the functionality of the codebase. They help improve the documentation and ensure consistency throughout.

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I added a changeset to account for this change.

Reviewer Checklist:

My review includes a synopsis of the changes and potential issues.
The code style is enforced.
There are no risky or concerning changes in the PR.

Signed-off-by: rusttech <[email protected]>

small grammar fix

* Corrected errors in docs * Update bug-bounty-program.mdx --------- Co-authored-by: Iain Nash <[email protected]>

undefined “7” and “8”

Dimitrolito · 2025-01-07T13:45:33Z

Hi @oveddan ,

Just a friendly reminder about pull request #470, which fixes several typographical and grammatical issues across various documentation files in the project. The PR is ready for review, and I’d appreciate it if you could take a look when you have a chance.

Thank you!

oveddan

thanks for catching and fixing all these. please undo the changes where instructed and then LGTM

docs/pages/bug-bounty/bug-bounty-program.mdx

oveddan · 2025-01-07T13:53:52Z

docs/pages/bug-bounty/bug-bounty-program.mdx

@@ -53,7 +53,7 @@ _Please note: All bounty rewards will be denoted as USD and will be paid out as
 ### Program Rules

 - Only submit one vulnerability per report.
- When duplicates occur, we will only accept the first report that was received, as long as it fulfils our submission criteria and can be fully reproduced.


oveddan · 2025-01-07T13:54:05Z

docs/pages/changelogs/1155-contracts.mdx

@@ -62,7 +62,7 @@

 ### Minor Changes

- [d460e79c](https://github.com/ourzora/zora-protocol/commit/d460e79c): - Introduced a `reduceSupply` function allowing an approved minter or admin to reduce the supply for a given token id. New supply must be less than the current maxSupply, and greater than or equal to the total minted so far.


good fix thank you

oveddan · 2025-01-07T13:54:27Z

docs/pages/changelogs/1155-contracts.mdx

@@ -251,7 +251,7 @@

  #### New ability to do premints against existing contracts

-  Executing premint against contracts not created via premint can be done with by passing a `premintCollection` argument to the new `premint` function:
+  Executing premint against contracts not created via premint can be done by passing a `premintCollection` argument to the new `premint` function:


thank you for catching this

oveddan · 2025-01-07T13:54:41Z

docs/pages/changelogs/1155-contracts.mdx

@@ -339,7 +339,7 @@
  - remove `ZoraCreator1155Impl.adminMintBatch` to save contract size
  - 50a4e09: - To support the MINTs contract passing the first minter as an argument to `premintV2WithSignerContract` - we add the field `firstMinter` to `premintV2WithSignerContract`, and then in the 1155 check that the firstMinter argument is not address(0) since it now can be passed in manually.

-### ZoraCreator1155Impl rewards splits are percentage based instead of a fixed value.
+### ZoraCreator1155Impl rewards splits are percentage-based instead of a fixed value.


oveddan · 2025-01-07T13:58:02Z

docs/pages/protocol-sdk/creator/onchain.mdx

@@ -128,7 +128,7 @@ with the 1155 contract address and the token creation parameters.

 ## Setting a price per token

-A price per token can be optionally set to earn eth additional on the primary sale when each token is minted, by setting `token.salesConfig.pricePerToken`.  
+A price per token can be optionally set to earn additional ETH on the primary sale when each token is minted, by setting `token.salesConfig.pricePerToken`.  


oveddan · 2025-01-07T13:58:18Z

docs/pages/protocol-sdk/collect/getTokensOfContract.mdx

@@ -1,6 +1,6 @@
 # `getTokensOfContract`

-**Both onchain** and **premint (gaslessly created)** tokens of a Zora 1155 contract can be retrieved using the the Collector Client function 
+**Both onchain** and **premint (gaslessly created)** tokens of a Zora 1155 contract can be retrieved using the Collector Client function 


oveddan · 2025-01-07T13:58:41Z

docs/pages/contracts/ZoraTimedSaleStrategy.mdx

@@ -139,7 +138,7 @@ The logic for launching the secondary market is designed with a few requirements

 - The secondary market starting price should be 0.000111 eth per token
 - There should be an equal amount of ERC20 to ERC1155 tokens minted/total supply
- Each owned ERC1155 should be backed and unwrappable by 1 ERC20, and visa versa.
+- Each owned ERC1155 should be backed and unwrappable by 1 ERC20, and vice versa.


oveddan · 2025-01-07T13:59:25Z

docs/pages/contracts/ZoraTimedSaleStrategy.mdx

@@ -26,8 +26,7 @@ As soon as the secondary market is launched the mint fees earned by the market w
 The ZoraTimedSaleStrategy contract is used to create a timed sale for a Zora 1155 token. When it is configured for an 1155 contract and token via the `setSale` function,
 specifying the `saleStart` and `saleEnd` of the sale, it creates a new ERC20z token and corresponding Uniswap V3 pool for a WETH pair with the ERC20z with a 1% fee.

-To mint an 1155 token, the `mint` function is called on the ZoraTimedSaleStrategy contract with the mint fee of 0.000111 eth x quantity to mint sent with the call. In the `mint` call, 0.0000111 eth x quantity is held in escrow to bootstrap liquidity for the Uniswap V3 pool, the rest is distributed as rewards.  
-via the [ProtocolRewards](./rewards) contract, and x quantity of 1155s is minted to the `recipient`.
+To mint an 1155 token, the `mint` function is called on the ZoraTimedSaleStrategy contract with the mint fee of 0.000111 eth x quantity to mint sent with the call. In the `mint` call, 0.0000111 eth x quantity is held in escrow to bootstrap liquidity for the Uniswap V3 pool, the rest is distributed as rewards via the [ProtocolRewards](./rewards) contract, and x quantity of 1155s is minted to the `recipient`.


docs/pages/contracts/ZoraTimedSaleStrategy.mdx

Dimitrolito · 2025-01-08T10:09:50Z

Hi @oveddan ,

Thanks for the feedback! I’ve reverted the changes as requested and undone the modifications.

Let me know if anything else needs to be adjusted

intls and others added 11 commits December 3, 2024 09:46

Updated errors and typos (ourzora#463)

75e8fee

chore: remove redundant words in comment (ourzora#468)

1bb709b

Signed-off-by: rusttech <[email protected]>

Update 1155-contracts.mdx (ourzora#454)

5bfcbbf

small grammar fix

fix: corrected major errors in docs (ourzora#460)

e1474a1

* Corrected errors in docs * Update bug-bounty-program.mdx --------- Co-authored-by: Iain Nash <[email protected]>

Update DEVELOPING.md (ourzora#450)

30fa57e

undefined “7” and “8”

typos bug-bounty-program.mdx

e1b85b0

typos Metadata.mdx

1339adc

typos Selling1155.mdx

d9d0fb2

typos ZoraTimedSaleStrategy.mdx

a9d5f92

typos network.mdx

7247743

typos README.md

e965100

oveddan force-pushed the main branch from 30fa57e to 839e006 Compare December 23, 2024 19:16

oveddan requested changes Jan 7, 2025

View reviewed changes

Dimitrolito added 3 commits January 8, 2025 11:59

Update bug-bounty-program.mdx

3e50a94

Update ZoraTimedSaleStrategy.mdx

b03d6da

Update README.md

a661255

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix typos and grammatical errors across multiple documentation files #470

Fix typos and grammatical errors across multiple documentation files #470

Dimitrolito commented Dec 6, 2024

Dimitrolito commented Jan 7, 2025

oveddan left a comment

oveddan Jan 7, 2025

oveddan Jan 7, 2025

oveddan Jan 7, 2025

oveddan Jan 7, 2025

oveddan Jan 7, 2025

oveddan Jan 7, 2025

oveddan Jan 7, 2025

oveddan Jan 7, 2025

Dimitrolito commented Jan 8, 2025

		@@ -62,7 +62,7 @@

		### Minor Changes

		- [d460e79c](https://github.com/ourzora/zora-protocol/commit/d460e79c): - Introduced a `reduceSupply` function allowing an approved minter or admin to reduce the supply for a given token id. New supply must be less than the current maxSupply, and greater than or equal to the total minted so far.

Fix typos and grammatical errors across multiple documentation files #470

Are you sure you want to change the base?

Fix typos and grammatical errors across multiple documentation files #470

Conversation

Dimitrolito commented Dec 6, 2024

Motivation and Context:

Changes:

Impact:

Checklist:

Reviewer Checklist:

Dimitrolito commented Jan 7, 2025

oveddan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Dimitrolito commented Jan 8, 2025