8000 feat: add YIP-62 by philburrrt · Pull Request #403 · yearn/yearn-docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
This repository was archived by the owner on May 1, 2023. It is now read-only.

feat: add YIP-62 #403

Merged
merged 2 commits into from
Jun 29, 2021
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
8000
Diff view
24 changes: 12 additions & 12 deletions contributors/working-on-docs.md
< 10000 tr data-hunk="b7e9adeeb22db5f17bec179fc4f98ebba45a3d5fc55eb8047e41f8a49fc0182d" class="show-top-border">
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ Here's how to contribute using issues:

1. Create an issue in https://github.com/yearn/yearn-docs

![](https://i.imgur.com/m4J2vKh.jpg)
![](https://i.imgur.com/m4J2vKh.jpg)

2. Title your proposed changes - Make it clear what you are editing or adding
3. Paste the changes directly from your HackMD into the 'Write' section
4. Click 'Submit new issue'

![](https://i.imgur.com/fbvUX1t.jpeg)
![](https://i.imgur.com/fbvUX1t.jpeg)

---

Expand All @@ -34,21 +34,21 @@ Another simple way to contribute is through the built in 'Edit on GitHub' button

1. Find the 'Edit on GitHub' button on the top right of the docs page.

![](https://i.imgur.com/raB4DUB.jpg)
![](https://i.imgur.com/raB4DUB.jpg)

2. Find the pencil button on the GitHub page that opens. It will say 'Edit the file in your fork of this project'

![](https://i.imgur.com/boWmvln.jpg)
![](https://i.imgur.com/boWmvln.jpg)

3. From here, you will be able to edit any of the copy. Once you're finished, give your changes a title and a description at the bottom and 'Propose Changes'

![](https://i.imgur.com/oESKgwx.jpg)
![](https://i.imgur.com/oESKgwx.jpg)

4. After you 'Propose changes' GitHub will create a branch of the yearn-docs repository for you and show a summary of the changes you made. If everything looks right and complies with the [Writing Style Guide](https://docs.yearn.finance/contributors/writing-style-guide), click 'Create pull request'

5. In your pull request (PR), give enough context about your changes for the repo admin to understand why they should be accepted. Afterwards, click 'Create pull request' and the admins will either merge, deny or make a comment.

![](https://i.imgur.com/iTGJanv.jpeg)
![](https://i.imgur.com/iTGJanv.jpeg)

---

Expand All @@ -64,32 +64,32 @@ Cloning a repository is ideal if you are working on more than one page.
4. Fork the [yearn/yearn-docs](https://github.com/yearn/yearn-docs) repository
- If you are translating, fork the branch that has the name of the language you are translating to. For example, Portuguese is the [portuguese](https://github.com/yearn/yearn-docs/tree/portuguese) docs are contained branch. You will need the same file structure as this branch to merge changes into it.

![](https://i.imgur.com/vVpFt7a.jpeg)
![](https://i.imgur.com/vVpFt7a.jpeg)

5. Login to GitHub Desktop, find your forked repository and clone it

![](https://i.imgur.com/7ycrC2F.jpg)
![](https://i.imgur.com/7ycrC2F.jpg)

6. Click 'contribute to parent project'. This only effects your upstream and origin and upstream branch, which can be edited through the command line
7. Open the repository in VSCode

![](https://i.imgur.com/Q0jWQic.jpg)
![](https://i.imgur.com/Q0jWQic.jpg)

8. Create a new branch and give it a title that has to do with your current task. Keeping different tasks in different branches is important for organizational purposes
9. Find the page you are looking to edit in VSCode's sidebar. They follow the same structure as the GitBook UI. README.md will always be

![](https://i.imgur.com/dIfrmfU.png)
![](https://i.imgur.com/dIfrmfU.png)

10. Edit the .md file, save it and minimize VSCode
11. GitHub Desktop will now show that you have changed a file. Give your change (commit) a title and description, then click 'commit to master'

![](https://i.imgur.com/XE2Ghim.jpg)
![](https://i.imgur.com/XE2Ghim.jpg)

12. Now, your changes are committed to your local branch. In order to push them to your public GitHub repo, click 'publish branch'
13. You now see a notification suggesting to make a pull request (PR) both on GitHub Desktop and the website. If you don't see this, you can go to https://github.com/yearn/yearn-docs and create one from there
14. Click on 'create pull request' and you should see the following screen

![](https://i.imgur.com/r8JuC84.jpg)
![](https://i.imgur.com/r8JuC84.jpg)

15. Make sure the base repository is 'yearn/yearn-docs' and the base is 'master'. (unless you are contributing to translated versions, in which case, the base should be the name of the language you are translating) The head repository should be 'your-username/yearn-docs' and the compare should be 'your-branch-name'
16. Make sure that your PR has all of the information needed to contextualize the change and that your changes comply with the [Writing Style Guide](https://docs.yearn.finance/contributors/writing-style-guide). Once you create a pull request, it will be sent to the repo admins who can approve it to be merged into the live site.
Expand Down
1 change: 1 addition & 0 deletions governance/proposal-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Yearn Improvement Proposals (YIPs), Yearn Delegation Proposals (YDPs) and Yearn
|[59](https://snapshot.org/#/yearn/proposal/QmdRCXH6BQpNcucoZqAtS5hQKjckE2428qiZoWjxmJXbs3)|Temporarily extend Multisig empowerment|[lehnberg](https://github.com/lehnberg)|
|[60](https://snapshot.org/#/ybaby.eth/proposal/QmNqAqRKMFcoRjaRYAKCVETij6sjJ4S1293kbpYDMVvcjB)|Airdrops to Yearn Vaults|[lehnberg](https://github.com/lehnberg)|
|[61](https://snapshot.org/#/ybaby.eth/proposal/QmSMyYeKrRpnA7Xn56o2NtbCUzxmhzCupL7LxMA1reXxq4)|Governance 2.0|[tracheopteryx](https://github.com/tracheopteryx), [lex_node](https://github.com/lex-node)|
|[62](https://snapshot.org/#/ybaby.eth/proposal/QmddCbGYbkooZ1zp8oYnbBz6frXLRc9xbkapXcuZcdzmMF)|Change Two Multisig Signers|[lehnberg](https://github.com/lehnberg), [tracheopteryx](https://github.com/tracheopteryx), [Klim K](https://github.com/milkyklim), [banteg](https://github.com/banteg)|

## Rejected

Expand Down
1 change: 0 additions & 1 deletion resources/guides/how-to-understand-yveCRV.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ As with all vaults, if you are depositing for the first time two transactions ar
Alternatively, you can buy yveCRV directly on [Sushiswap](https://app.sushi.com/swap?inputCurrency=ETH&outputCurrency=0xc5bDdf9843308380375a611c18B50Fb9341f502A). The contract address is [0xc5bddf9843308380375a611c18b50fb9341f502a](https://etherscan.io/address/0xc5bddf9843308380375a611c18b50fb9341f502a).

![](https://i.imgur.com/DrnPl9N.png)
*Buying yveCRV on Sushiswap*

## What are the benefits of depositing into this vault?

Expand Down
1 change: 0 additions & 1 deletion E721 resources/guides/how-to-understand-yvecrv.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ As with all vaults, if you are depositing for the first time two transactions ar
Alternatively, you can buy yveCRV directly on [Sushiswap](https://app.sushi.com/swap?inputCurrency=ETH&outputCurrency=0xc5bDdf9843308380375a611c18B50Fb9341f502A). The contract address is [0xc5bddf9843308380375a611c18b50fb9341f502a](https://etherscan.io/address/0xc5bddf9843308380375a611c18b50fb9341f502a).

![](https://i.imgur.com/DrnPl9N.png)
*Buying yveCRV on Sushiswap*

## What are the benefits of depositing into this vault?

Expand Down
1 change: 1 addition & 0 deletions yearn-finance/yvaults/vault-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
If your yVault generates profit, the share price of your yVault tokens will increase. This happens because there are more underlying tokens in the yVault to redeem upon withdrawal.

![](https://i.imgur.com/OtK6kAA.png)

*The yvYFI token at [Etherscan](https://etherscan.io/token/0xE14d13d8B3b85aF791b2AADD661cDBd5E6097Db1#readContract), showing its name, total assets and price per share.*

Once a user's liquidity is withdrawn from the yVault, their yVault Token will be burned. yVault Tokens are [ERC20](https://docs.ethhub.io/built-on-ethereum/erc-token-standards/erc20/), meaning they can be transferred and traded as any other common Ethereum token.
Expand Down
0