Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving documentation readability: error corrections #465

Merged
merged 4 commits into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { HomePageLogo } from "../components/HomePageLogo";
<HomePageLogo dark="/zora-wordmark-white.svg" light="/zora-wordmark-black.svg" />
<HomePage.Tagline>Explore our guides and examples to integrate Zora </HomePage.Tagline>
<img src="/zora-docs-hero-image.png" className="hero-image" />
<p>Build your project using the Zora Protocol and plug into over $25m of rewards out of the box. We’ve created a series of tools that makes it easy to get started building on Zora.</p>
<p>Build your project using the Zora Protocol and plug into over $25m of rewards out of the box. We’ve created a series of tools that make it easy to get started building on Zora.</p>
</HomePage.Root>

<CardContainer>
Expand Down
2 changes: 1 addition & 1 deletion packages/1155-deployments/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ Contains deployment scripts, deployed addresses and versions for the Zora 1155 C

## Package contents

- [Deployment scripts](./script/) for deployment Zora Protocol Contracts
- [Deployment scripts](./script/) for deploying Zora Protocol Contracts
- [Deployed addresses](./addresses/) containing deployed addresses and contract versions by chain.
2 changes: 1 addition & 1 deletion packages/protocol-rewards/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Documentation is available at [docs.zora.co](https://docs.zora.co).

## Implementation Caveats

The `ProtocolRewards` contract has a implementation caveat. If you send any value to a zero (`address(0)`) address in `depositRewards`, that value is implicitly burnt by being locked in the contract at the zero address. The function will not revert or redirect those funds as currently designed. We may re-visit this design in the future but for the release of v1.1 this is the current and expected behavior.
The `ProtocolRewards` contract has an implementation caveat. If you send any value to a zero (`address(0)`) address in `depositRewards`, that value is implicitly burned by being locked in the contract at the zero address. The function will not revert or redirect those funds as currently designed. We may re-visit this design in the future but for the release of v1.1 this is the current and expected behavior.

## Deployed Addresses

Expand Down
2 changes: 1 addition & 1 deletion packages/sparks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ set of recipients in the form of fees and rewards, with the percentage split
configured in the creator contract. When a SPARK is redeemed, the underlying
value is distributed to a desired recipient, and the SPARK is burned.

The `ZoraSparksManager` is an administrated and upgradeble that contract controls which SPARK token id can be minted for each currency type,
The `ZoraSparksManager` is an administrated and upgradeable that contract controls which SPARK token id can be minted for each currency type,
thus defining the current price for collecting a SPARK in that currency type.
While it controls the logic around which SPARKs can be minted, once a SPARK is minted, the corresponding value is deposited into the
immutable `ZoraSparks1155` contract; only the owner of the SPARKs can access the underlying deposited funds by redeming the SPARKs or choose to do with their SPARKs, and since that contract is immutable these rules could never change.
Expand Down