Docs Refactor (#388)

* update intro * update vaults information * vaults updates 2 * update ycrv * move woofy to r&d section * update broken erc20 link * update ycrv lp info * add veToken holdings * add info about zapping fees * update custom token guides * fix ycrv factory pool link * add refactor files * update titles * update titles * update header * move v3 up * fix: yearn.vision info * fix: wording ycrv overview * lowercase * delete extra word * add polygon network * fix: ycrv sidebar * update ylockers headers * refactor r & d to deprecated * update yEarn * update woofy page * remove: llama pay info * refactor v3 sidebar * fix dead link * fix dead link * Update sidebarsContributing.js * Update sidebarsGettingStarted.js * Update veyfi.md * Update veyfi.md * Update sidebarsGettingStarted.js * Create veyfi.md * Update sidebarsGettingStarted.js * Delete docs/contributing/governance/veyfi.md * update homepage * update footer * Update docusaurus.config.js * Update docusaurus.config.js * update snapshot link * Update homepageFeatures.js * update intro vaults link * Update yearn-data.md remove dead links form data page --------- Co-authored-by: 0xBasically <[email protected]>
yearn · Feb 20, 2024 · 8f9326a · 8f9326a
1 parent 6aa357a
commit 8f9326a
Show file tree

Hide file tree

Showing 30 changed files with 203 additions and 356 deletions.
diff --git a/docs/contributing/operations/budget.md b/docs/contributing/operations/budget.md
@@ -9,6 +9,4 @@ The team recommendations to make requests are:
 - When coordinating efforts with others, apply as a team (not as separate individuals)
 - Shorter timeframes of 1 to 3 months may have better rates of approval
 
-All Yearn payments streams can be visualized at our [LlamaPay Streams Dashboard](https://llamapay.io/streams?chainId=1&address=ychad.eth)
-
 ### [Send a budget request on GitHub](https://github.com/yearn/budget/issues/new/choose)
diff --git a/versioned_docs/version-0.4.6/yearn-api.md → docs/developers/v2/yearn-api.md b/versioned_docs/version-0.4.6/yearn-api.md → docs/developers/v2/yearn-api.md
diff --git a/docs/developers/v2/yearn-data.md b/docs/developers/v2/yearn-data.md
@@ -27,11 +27,3 @@ yDaemon is a RESTful API that hydrates subgraph responses with more data, like A
 - **Source:** https://github.com/yearn/ydaemon
 - **Docs:** https://ydaemon.yearn.farm/
 - **Guide:** https://medium.com/iearn/ydaemon-one-api-to-unify-all-yearn-data-4fc74dc9a33b
-
-### yDaemon Data Sources
-
-To build the yDaemon API, data is fetched from several Yearn data sources:
-- [Yearn Subgraph](https://thegraph.com/explorer/subgraph?id=5xMSe3wTNLgFQqsAc5SCVVwT4MiRb5AogJCuSN9PjzXF) as the base data source.
-- [Yearn Meta](https://github.com/yearn/yearn-meta) for some basic data and information updated by the Yearn team.
-- [Yearn API](https://api.yearn.fi/) for the APY computation.
-- [Yearn Lens Oracle](https://etherscan.io/address/0xca11bde05977b3631167028862be2a173976ca11) for tokens and vault prices.
diff --git a/...cs/version-0.4.6/yearn-lens/yearn-lens.md → docs/developers/v2/yearn-lens.md b/...cs/version-0.4.6/yearn-lens/yearn-lens.md → docs/developers/v2/yearn-lens.md
diff --git a/docs/getting-started/guides/how-to-add-a-custom-token-to-metamask.md b/docs/getting-started/guides/how-to-add-a-custom-token-to-metamask.md
@@ -1,49 +1,11 @@
 # How to Add a Custom Token to MetaMask
 
-Here's how you add a custom token to MetaMask.
-
-## Visual Walkthrough
-
-### Method One
-1\) Click on the `Fox` icon to bring up the Metamask prompt.
-
-![](https://i.imgur.com/R4K0STZ.png)
-
-2\) Click on the etherscan icon (besides the `Fox` icon) to view token contract details. 
-
-3\) Confirm the token and click `Add Token`.
-
-![](https://i.imgur.com/W0MsHOP.png)
-
-### Method Two
-1\) Open MetaMask and click `Assets` to see the tokens in your wallet.
-
-![](https://i.imgur.com/N34iMar.png)
-
-2\) Scroll down to the bottom and click `Add Token`.
-
-![](https://i.imgur.com/hRd2MD7.png)
-
-3\) Click `Custom Token`.
-
-![](https://i.imgur.com/rGbV1eT.png)
-
-4\) Paste the contract address for yUSD **0x5dbcF33D8c2E976c6b560249878e6F1491Bca25c** into the `Token Contract Address` field.
-
-![](https://i.imgur.com/6H2JhRN.png)
-
-5\) Click `Edit` to change the Token Symbol.
-
-![](https://i.imgur.com/E12XN8x.png)
-
-6\) Type in **yUSD** and click `Next`.
-
-![](https://i.imgur.com/kNkrqj3.png)
-
-7\) Hooray! Now you can see your balance of yUSD. Click `Add Tokens` to finish up.
-
-![](https://i.imgur.com/gkt6KME.png)
-
-8\) You're done. You'll now see yUSD in your assets list so it's easier to track and use.
-
-![](https://i.imgur.com/ZgtftOw.png)
+Follow the external guides provided by MetaMask:
+
+- [Automatic token detection](https://support.metamask.io/hc/en-us/articles/360015489031-How-to-display-tokens-in-MetaMask#h_01FWH48EA3JNK6V5JXCR6XVWZD)
+- [Adding a token using the search bar](https://support.metamask.io/hc/en-us/articles/360015489031-How-to-display-tokens-in-MetaMask#h_01FWH48R495MR9DQEDHJ89QNDA)
+- [Adding a custom token](https://support.metamask.io/hc/en-us/articles/360015489031-How-to-display-tokens-in-MetaMask#h_01FWH492CHY60HWPC28RW0872H)
+- [Removing/hiding tokens](https://support.metamask.io/hc/en-us/articles/360015489031-How-to-display-tokens-in-MetaMask#h_01FWH499MRDT5QC4R3KNPQNRWB)
+- [Finding the token contract address](https://support.metamask.io/hc/en-us/articles/360015489031-How-to-display-tokens-in-MetaMask#h_01FWKCA7MJG5HT2MSZZ8DJ0QCF)
+- [Adding a token using the block explorer](https://support.metamask.io/hc/en-us/articles/360015489031-How-to-display-tokens-in-MetaMask#h_01FWH752DWRBMH57M6DZRFSPQD)
+- [Adding a token using a coin listing site](https://support.metamask.io/hc/en-us/articles/360015489031-How-to-display-tokens-in-MetaMask#h_01G13EJA2ZSJD1A743FVNCASNS)
diff --git a/docs/getting-started/intro.md b/docs/getting-started/intro.md
@@ -4,10 +4,15 @@ Yearn Finance is DeFi’s premier yield aggregator. Giving individuals, DAOs and
 
 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.
 
+- https://yearn.fi/
+
 ## Vaults
 
 Yearn Vaults 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 Vaults V3: https://yearn.fi/v3
+- Yearn Vaults V2: https://yearn.fi/vaults
+
 ## 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 \(&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](https://docs.yearn.fi/security/multisig) for the list of multisig signers. For more info about the governance process, please consult the [Governance FAQ](https://docs.yearn.fi/resources/faq#governance) and [YIP-61: Governance 2.0](https://gov.yearn.fi/t/yip-61-governance-2-0/10460).

diff --git a/docs/contributing/governance/veyfi.md → docs/getting-started/products/veyfi.md b/docs/contributing/governance/veyfi.md → docs/getting-started/products/veyfi.md
@@ -1,4 +1,4 @@
-# veYFI
+# Overview
 
 veYFI incorporates [YIP-56: Buyback and Build](https://gov.yearn.fi/t/yip-56-buyback-and-build/8929) funds into YFI tokenomics. Users can lock YFI tokens and receive veYFI, which allows them to boost vault rewards and vote on where bought-back YFI will be sent.
 
@@ -8,7 +8,7 @@ Contract Address: [`0x90c1f9220d90d3966fbee24045edd73e1d588ad5`](https://ethersc
 
 Governance Forum Thread: https://gov.yearn.fi/t/yip-65-evolving-yfi-tokenomics
 
-## Overview
+## veYFI Overview
 
 - Receives bought-back YFI as reward.
 - Locking is similar to the ve-style program of Curve.
@@ -90,7 +90,7 @@ dYFI (previously specified as oYFI) is a token introduced as part of Yearn's veY
 
 - Governance Forum Thread: https://gov.yearn.fi/t/yip-73-activate-veyfi-rewards-with-oyfi-gauges
 
-### Overview
+### dYFI Overview
 
 - Implements the ERC-20 standard.
 - Gives its bearer the right to redeem an equivalent YFI in exchange for ETH.

diff --git a/docs/getting-started/products/ylockers/ycrv/faq.md b/docs/getting-started/products/ylockers/ycrv/faq.md
@@ -1,9 +1,7 @@
-# yCRV FAQ
-
-## Launch and Migration
+# Launch and Migration FAQ
 
 ### When will yCRV launch?
-Contracts are live, you can find relevant addresses [here](https://docs.yearn.fi/getting-started/products/ycrv/overview#addresses).
+Contracts are live, you can find relevant addresses [here](https://docs.yearn.fi/getting-started/products/ylockers/ycrv/overview#addresses).
 
 ### Should I migrate now from yveCRV and yvBOOST?
 Yes! Incentives have moved to the new system. yveCRV and yvBOOST will no longer receive yield.
@@ -18,4 +16,4 @@ No. After the cut-over date, all incentives will move to the new yCRV system.
 Nope! You can migrate anytime in the future. Contracts are trustless and migrations cannot be stopped.
 
 ### How are Curve DAO governance votes handled in this system?
-The Yearn [governance multisig](https://etherscan.io/address/0xfeb4acf3df3cdea7399794d0869ef76a6efaff52) will retain the sole ability to cast votes in the Curve DAO. They will do so with close consultation with the [Crypto Risk Team](https://twitter.com/cryptorisksteam) and other Curve DAO stakeholders to ensure risk is properly assessed and all votes promote the long-term interests of the Curve DAO. While it is possible that the yCRV system can be upgraded to someday grant these voting rights to yCRV token holders (only if enforcing a sufficiently long lock time), there is no current plan to do so. 
+The Yearn [governance multisig](https://etherscan.io/address/0xfeb4acf3df3cdea7399794d0869ef76a6efaff52) will retain the sole ability to cast votes in the Curve DAO. They will do so with close consultation with the [Crypto Risk Team](https://twitter.com/cryptorisksteam) and other Curve DAO stakeholders to ensure risk is properly assessed and all votes promote the long-term interests of the Curve DAO. While it is possible that the yCRV system can be upgraded to someday grant these voting rights to yCRV token holders (only if enforcing a sufficiently long lock time), there is no current plan to do so. 
diff --git a/docs/getting-started/products/ylockers/ycrv/overview.md b/docs/getting-started/products/ylockers/ycrv/overview.md
@@ -1,4 +1,4 @@
-# yCRV
+# Overview
 
 ![](https://i.imgur.com/ni42qE6.png)
 
@@ -18,14 +18,14 @@ _or_
 
 - Migrate from legacy tokens [yveCRV and yvBOOST](#how-yvecrv-and-veboost-functionality-was-migrated-to-ycrv).
 
-Both operations mint yCRV to the user at a 1:1 rate. Users migrating from yvBOOST can use the zap at [y.finance](https://y.finance) to efficiently unwrap their tokens to yveCRV and migrates to yCRV in a single step. Of course, users can also choose to purchase yCRV from the new Curve factory pool [here](https://curve.fi/factory/192).
+Both operations mint yCRV to the user at a 1:1 rate. Users migrating from yvBOOST can use the zap at https://yearn.fi/ycrv to efficiently unwrap their tokens to yveCRV and migrate to yCRV in a single step. Of course, users can also choose to purchase yCRV from the new Curve factory pool: https://curve.fi/#/ethereum/pools/factory-v2-280/deposit
 
 ### 'Activated'-tokens
 
 Yearn passes all benefits of its veCRV position on to yCRV users who hold one of its **activated-tokens:**
 
 - [**st-yCRV (Staking Rewards):**](#staked-ycrv) [yVault](https://medium.com/iearn/yearn-finance-explained-what-are-vaults-and-strategies-96970560432) that receives admin fees and bribes from locked CRV.
-- [**lp-yCRV (Liquidity Pool Rewards):**](#lpd-ycrvcrv) yVault for CRV/yCRV LP tokens, autocompounds emissions and fees.
+- [**lp-yCRV (Liquidity Pool Rewards):**](#lpd-ycrvcrv) yVault for CRV LP tokens, autocompounds emissions and fees.
 
 > Note: a third activated token, vl-yCRV, was planned but not rolled out due to a lack of demand.
 
@@ -46,27 +46,27 @@ Under the hood, st-yCRV is a Yearn v2 vault, allowing users to sit back, relax a
 
 ![](https://i.imgur.com/3JNhzWR.png)
 
-Liquidity Pool'd yCRV provides liquidity to the new CRV/yCRV pool on Curve, and lp-yCRV holders receive this LP fees and emissions. When you zap to this token, under the hood, you are entering an LP position in the yCRV/CRV pool and depositing the LP tokens into the lp-yCRV yVault.
+Liquidity Pool'd yCRV provides liquidity to the new CRV pool on Curve, and lp-yCRV holders receive this LP fees and emissions. When you zap to this token, under the hood, you are entering an LP position in the yCRV/CRV pool and depositing the LP tokens into the lp-yCRV yVault.
 
 This is also a Yearn v2 vault with a strategy that deposits all CRV emissions generated back into the pool to grow the position. Like st-yCRV this is designed to be a set and forget token that auto harvests and auto compound rewards.
 
 Yearn will mark 1 veCRV worth of voting power for every 1 yCRV in this position to vote in favor of yCRV Curve gauge - increasing CRV emissions to users.
 
 ## How yveCRV and yvBOOST functionality was migrated to yCRV
 
-yveCRV and yvBOOST are being deprecated, and there is a migration path available to users. The functionality of both was integrated into [st-yCRV](#staked-ycrv) so if you are looking for the same benefits check the [guide](https://docs.yearn.fi/getting-started/products/ycrv/guide) on how to migrate from the legacy tokens using yearn's UI
+yveCRV and yvBOOST are being deprecated, and there is a migration path available to users. The functionality of both was integrated into [st-yCRV](#staked-ycrv) so if you are looking for the same benefits check the [guide](https://docs.yearn.fi/getting-started/products/ylockers/ycrv/guide) on how to migrate from the legacy tokens using yearn's UI
 
 ![](https://i.imgur.com/Htl3AgP.png)
 
 ## Addresses
 
 - **yCRV:** [0xFCc5c47bE19d06BF83eB04298b026F81069ff65b](https://etherscan.io/token/0xFCc5c47bE19d06BF83eB04298b026F81069ff65b)
 - **st-yCRV (vault):** [0x27B5739e22ad9033bcBf192059122d163b60349D](https://etherscan.io/token/0x27B5739e22ad9033bcBf192059122d163b60349D)
-- **lp-yCRV (DEPRECATED):** [0xc97232527B62eFb0D8ed38CF3EA103A6CcA4037e](https://etherscan.io/token/0xc97232527B62eFb0D8ed38CF3EA103A6CcA4037e)
+- **lp-yCRV (DEPRECATED, The v2 pool is more efficient and has a price oracle):** [0xc97232527B62eFb0D8ed38CF3EA103A6CcA4037e](https://etherscan.io/token/0xc97232527B62eFb0D8ed38CF3EA103A6CcA4037e)
 - **lp-yCRV v2 (vault):** [0x6E9455D109202b426169F0d8f01A3332DAE160f3](https://etherscan.io/token/0x6E9455D109202b426169F0d8f01A3332DAE160f3)
 - **CRV/yCRV Curve Pool:** [0x453D92C7d4263201C69aACfaf589Ed14202d83a4](https://etherscan.io/token/0x453D92C7d4263201C69aACfaf589Ed14202d83a4)
 - **ZapYCRV.vy :** [0x01D7f32B6E463c96c00575fA97B8224326C6A6B9](https://etherscan.io/token/0x01D7f32B6E463c96c00575fA97B8224326C6A6B9)
-- **yCRV Interface:** http://y.finance/
+- **yCRV Interface:** https://yearn.fi/ycrv
 
 ## Read More
 

diff --git a/docs/getting-started/products/ylockers/yprisma/overview.md b/docs/getting-started/products/ylockers/yprisma/overview.md
@@ -1,4 +1,4 @@
-# yPRISMA
+# Overview
 
 Claim and deposit at [yprisma.yearn.fi](https://yprisma.yearn.fi)
 

diff --git a/docs/getting-started/products/yvaults/overview.md b/docs/getting-started/products/yvaults/overview.md
@@ -23,7 +23,9 @@ The old structure used before the changes brought by [YIP-69](https://gov.yearn.
 | Management Fee  | 0%  |
 | Performance Fee | 20% |
 
-On the [yearn.fi](https://yearn.fi/) user interface, yield is displayed as net APY. This means that both fees and compounding returns are taken into consideration in the rates presented. Since harvests don't occur on a set basis, yield is estimated based on historical data. For more information, see [How to Understand yVault ROI](https://docs.yearn.fi/getting-started/guides/how-to-understand-yvault-roi)
+On the [yearn.fi](https://yearn.fi/) user interface, yield is displayed as net APY. This means that both fees and compounding returns are taken into consideration in the rates presented. Since harvests don't occur on a set basis, yield is usually estimated based on historical data. For more information, see [How to Understand yVault ROI](https://docs.yearn.fi/getting-started/guides/how-to-understand-yvault-roi)
+
+- For vaults deployed by the vault [factory](https://docs.yearn.fi/getting-started/products/yvaults/vault-factory) the performance fee is 10% instead of 20%.
 
 ## v2 yVault Improvements
 

diff --git a/docs/getting-started/products/yvaults/v3.md b/docs/getting-started/products/yvaults/v3.md
@@ -1,4 +1,5 @@
-# Vaults Version 3
+# Overview
+
 Version 3 yVaults iterates on Version 2 by increasing robustness and developing Yearn’s path towards further decentralization, while keeping the same proven product (yield-bearing tokens) that abstract builders and users from the hard work of yield farming. Version 3 will both be able to have the same functionality as Version 2, but with many more added benefits and improvements to continue to grow the Yearn ecosystem.
 
 V3 also sees the introduction of "Tokenized Strategies". In V3 the strategies are now capable of being standalone 4626 vaults themselves. These single-strategy vaults can be used as stand-alone vaults or as a function of the 4626 standard easily added as a strategy to any of the multi-strategy "Allocator Vaults".
@@ -37,10 +38,10 @@ Periphery Modules are a separate layer of optional contracts to use with vaults
 
 [Tokenized Strategy Specification](https://github.com/yearn/tokenized-strategy/blob/master/SPECIFICATION.md)
 
-**For More information visit the [V3 section](https://docs.yearn.fi/developers/v3/overview) of the docs.**
+# Read More
 
+**For more information visit the V3 developer section: https://docs.yearn.fi/developers/v3/overview**
 
-# Read More
 - https://github.com/yearn/yearn-vaults-v3
 - https://github.com/yearn/tokenized-strategy
 - https://medium.com/iearn/yearnv3-motivation-and-design-107840cb4844

diff --git a/docs/getting-started/products/yvaults/vault-factory.md b/docs/getting-started/products/yvaults/vault-factory.md
@@ -145,7 +145,7 @@ Follow these steps to create a new vault with the UI:
 
 <img src="https://i.imgur.com/l7Z7oYm.png" />
 
-4. Sign the transaction and the vault will be created
+4. Sign the transaction and the vault will be created (the signing interface is specific to your wallet provider, this one is [Frame](https://frame.sh/))
 
 <img src="https://i.imgur.com/uRhX2VB.png" width="280" />