Skip to content

Commit

Permalink
Feat: update user docs structure and add Yearn Principles (#458)
Browse files Browse the repository at this point in the history
* add principles page

* update User Docs sidebar

* update dark mode text color on principles page

* update sidebar + fix merge conflicts

* update deprecated proj sidebar

* update products intro page and dao intro page

* update yETH

* fix link

* remove redundant contract info and make links pretty
  • Loading branch information
rossgalloway authored Sep 22, 2024
1 parent 6b72120 commit 80f7f9d
Show file tree
Hide file tree
Showing 34 changed files with 398 additions and 417 deletions.
9 changes: 9 additions & 0 deletions docs/contributing/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Yearn DAO

![image](/img/dao-pages/here-we-are-cropped.jpg)

Yearn is a collective of developers, users, thinkers, and doers all working toward making the best suite of on-chain, decentralized, yield products. There are no bosses or interns, no board of directors or HR department, only those who contribute to, participate in, and explore Yearn. Yearn started as an experiment with a week long release of YFI and continues as an experiment today.

## Governance

The Yearn ecosystem is controlled by YFI token holders who submit and vote on off-chain proposals that govern the ecosystem. Proposals that generate majority support \(>50% of the vote\) are implemented by a 9-member multi-signature wallet. Changes must be signed by 6 out of the 9 wallet signers to be implemented. The members of the multi-signature wallet were voted in by YFI holders and are subject to change from future governance votes. Please refer to the [multisig documentation](/security/multisig) for the list of multisig signers. For more info about the governance process, please consult the [Governance FAQ](/resources/faq#governance) and [YIP-61: Governance 2.0](https://gov.yearn.fi/t/yip-61-governance-2-0/10460).
2 changes: 2 additions & 0 deletions docs/developers/addresses/ycrv-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,5 @@ A list of deployed yCRV contracts.
| lp-yCRV v1 (DEPRECATED) | [0xc97232527B62eFb0D8ed38CF3EA103A6CcA4037e](https://etherscan.io/address/0xc97232527B62eFb0D8ed38CF3EA103A6CcA4037e#code) |
| old CRV/yCRV Curve Pool (DEPRECATED) | [0x453D92C7d4263201C69aACfaf589Ed14202d83a4](https://etherscan.io/address/0x453D92C7d4263201C69aACfaf589Ed14202d83a4#code) |
| ZapYCRV.vy | [0x01D7f32B6E463c96c00575fA97B8224326C6A6B9](https://etherscan.io/address/0x01D7f32B6E463c96c00575fA97B8224326C6A6B9#code) |

<PrettyLink>[yCRV Docs](/getting-started/products/ylockers/ycrv/overview)</PrettyLink>
2 changes: 2 additions & 0 deletions docs/developers/addresses/yprisma-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,5 @@ A list of deployed yPrisma contracts.
| *yPRISMA LP Staking (yPRISMA rewards) | [0x6806D62AAdF2Ee97cd4BCE46BF5fCD89766EF246](https://etherscan.io/address/0x6806D62AAdF2Ee97cd4BCE46BF5fCD89766EF246) |
| *yCRV Staking (yPRISMA rewards) | [0x84c94d739e075b3C7431bdb1A005F0412DF828a5](https://etherscan.io/address/0x84c94d739e075b3C7431bdb1A005F0412DF828a5) |
**expired*

<PrettyLink>[yPRISMA Docs](/getting-started/products/ylockers/yprisma/overview)</PrettyLink>
33 changes: 15 additions & 18 deletions docs/getting-started/intro.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,26 @@
# Introduction
# Yearn Products

Yearn Finance is DeFi’s premier yield aggregator. Giving individuals, DAOs and other protocols a way to deposit digital assets and receive yield.

The protocol is maintained by various independent developers and is governed by YFI holders. You can find brief descriptions of Yearn's core products, the governance process, and links to active communication channels below.

<PrettyLink>https://yearn.fi/</PrettyLink>
![image](/img/product-pages/blueknight-product-banner.png)

## yVaults

Yearn Vaults (or yVaults) are capital pools that automatically generate yield based on opportunities present in the market. Vaults benefit users by socializing gas costs, automating the yield generation and rebalancing process, and automatically shifting capital as opportunities arise. End users also do not need to have proficient knowledge of the underlying protocols involved or DeFi, thus the Vaults represent a passive-investing strategy.

- Yearn V3 Vaults website: https://yearn.fi/v3
- Yearn V2 Vaults website: https://yearn.fi/vaults
- Docs section on yVaults can be found [here](products/yvaults/overview.md)
Yearn Vaults (aka yVaults) are capital pools that automatically generate yield based on opportunities present in the market. Vaults benefit users by socializing gas costs, automating the yield generation and rebalancing process, and automatically shifting capital as opportunities arise. End users do not need to have extensive knowledge of the underlying DeFi protocols and can use the vaults as passive-investing strategies.

## Governance
<PrettyLink>[Don't know what that means? Check out the yVault Docs](products/yvaults/overview.md)</PrettyLink>
<PrettyLink>[Yearn Vaults V3 dApp](https://yearn.fi/v3)</PrettyLink>
<PrettyLink>[Yearn Vaults V2 dApp](https://yearn.fi/vaults)</PrettyLink>

The Yearn ecosystem is controlled by YFI token holders who submit and vote on off-chain proposals that govern the ecosystem. Proposals that generate majority support \(&gt;50% of the vote\) are implemented by a 9-member multi-signature wallet. Changes must be signed by 6 out of the 9 wallet signers to be implemented. The members of the multi-signature wallet were voted in by YFI holders and are subject to change from future governance votes. Please refer to the [multisig documentation](/developers/security/multisig) for the list of multisig signers. For more info about the governance process, please consult the [Governance FAQ](/resources/faq#governance) and [YIP-61: Governance 2.0](https://gov.yearn.fi/t/yip-61-governance-2-0/10460).
## yLockers

## Communication Channels
yLockers are yVault products built to get the most out of DeFi protocol governance tokens based on Curve's Vote Escrow mechanics. Lock your tokens and get extra yield, but beware; They are in there to stay and can only be traded on decentralized exchanges.

Governance Forum [https://gov.yearn.fi/](https://gov.yearn.fi/)
<PrettyLink>[Don't know what that means? Check out the yLockers Docs](products/ylockers/overview.md)</PrettyLink>
<PrettyLink>[Yearn yCRV dApp](https://ycrv.yearn.fi/)</PrettyLink>
<PrettyLink>[Yearn yPRISMA dApp](https://yprisma.yearn.fi/)</PrettyLink>

Discord [https://discord.gg/yearn](https://discord.gg/yearn)
## yPools

Telegram [https://t.me/yearnfinance](https://t.me/yearnfinance)
yPools are user-governed liquidity pools of different crypto-assets. They are risk adjusted baskets of community chosen derivatives of the base asset that earn yield from those underlying derivatives. The first yPool is yETH, which is a collection of different liquid staked version of ETH.

Reddit [https://www.reddit.com/r/yearn_finance/](https://www.reddit.com/r/yearn_finance/)
<PrettyLink>[Don't know what that means? Check out the yETH Docs](products/ypools/yeth/overview.md)</PrettyLink>
<PrettyLink>[Yearn yETH dApp](https://yearn.fi/yeth)</PrettyLink>
Loading

0 comments on commit 80f7f9d

Please sign in to comment.