8000 refactor: formatting fixes [DOC-87] by philburrrt · Pull Request #497 · 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.

refactor: formatting fixes [DOC-87] #497

Merged
merged 2 commits into from
Jul 26, 2021
Merged

refactor: formatting fixes [DOC-87] #497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97e5095
refactor: using yearn number formatting
philburrrt Jul 26, 2021
cd7f691
refactor: numbering, images and grammar
philburrrt Jul 26, 2021
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
108 changes: 71 additions & 37 deletions contributors/working-on-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,39 +16,53 @@ If you have no experience cloning and working on a repository, you can make your

Here's how to contribute using issues:

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

![](https://i.imgur.com/m4J2vKh.jpg)
<p align="center">
<img width="1400" height="300" src="https://i.imgur.com/m4J2vKh.jpg">
</p>

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'
2\. Title your proposed changes - Make it clear what you are editing or adding.

![](https://i.imgur.com/fbvUX1t.jpeg)
3\. Paste the changes directly from your HackMD into the 'Write' section.

4\. Click 'Submit new issue'.

<p align="center">
<img width="1255" height="615" src="https://i.imgur.com/fbvUX1t.jpeg">
</p>

---

## Editing through the documentation UI

Another simple way to contribute is through the built in 'Edit on GitHub' button that you will see on all pages of Yearn docs. For this, you won't need to use HackMD at all, just make sure to have a GitHub account.

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

![](https://i.imgur.com/raB4DUB.jpg)
<p align="center">
<img width="1117" height="428" src="https://i.imgur.com/raB4DUB.jpg">
</p>

2. Find the pencil button on the GitHub page that opens. It will say 'Edit the file in your fork of this project'
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)
<p align="center">
<img width="1246" height="467" src="https://i.imgur.com/boWmvln.jpg">
</p>

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'
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)
<p align="center">
<img width="1439" height="322" src="https://i.imgur.com/m4J2vKh.jpg">
</p>

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'
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.
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)
<p align="center">
<img width="1235" height="502" src="https://i.imgur.com/iTGJanv.jpeg">
</p>

---

Expand All @@ -58,40 +72,60 @@ Cloning a repository is ideal if you are working on more than one page.

**This is a basic guide that doesn't involve using the command prompt.** There are multiple ways to go about cloning and contributing to a repository. We encourage you to learn more about GitHub as it will help you troubleshoot any issues that you might encounter.

1. Login to your GitHub account
2. Install [GitHub Desktop](https://desktop.github.com)
3. Install [Visual Code Studio](https://code.visualstudio.com) (VSCode)
4. Fork the [yearn/yearn-docs](https://github.com/yearn/yearn-docs) repository
1\. Login to your GitHub account.

2\. Install [GitHub Desktop](https://desktop.github.com).

3\. Install [Visual Code Studio](https://code.visualstudio.com). (VSCode)

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)
<p align="center">
<img width="1399" height="180" src="https://i.imgur.com/vVpFt7a.jpeg">
</p>

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

<p align="center">
<img width="1339" height="754" src="https://i.imgur.com/7ycrC2F.jpg">
</p>

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

<p align="center">
<img width="633" height="400" src="https://i.imgur.com/Q0jWQic.jpg">
</p>

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.

5. Login to GitHub Desktop, find your forked repository and clone it
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/7ycrC2F.jpg)
<p align="center">
<img width="765" height="392" src="https://i.imgur.com/dIfrmfU.png">
</p>

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
10\. Edit the .md file, save it and minimize VSCode.

![](https://i.imgur.com/Q0jWQic.jpg)
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'.

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
<p align="center">
<img width="786" height="380" src="https://i.imgur.com/XE2Ghim.jpg">
</p>

![](https://i.imgur.com/dIfrmfU.png)
12\. Now, your changes are committed to your local branch. In order to push them to your public GitHub repo, click 'publish branch'.

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'
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.

![](https://i.imgur.com/XE2Ghim.jpg)
14\. Click on 'create pull request' and you should see the following screen.

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
<p align="center">
<img width="1400" height="300" src="https://i.imgur.com/m4J2vKh.jpg">
</p>

![](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'.

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.
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.


57 changes: 35 additions & 22 deletions using-yearn.md
View file
Open in desktop
10000
Original file line number Diff line number Diff line change
Expand Up @@ -12,38 +12,43 @@ First, **Connect your wallet** using the button at the top right corner. Multipl

## If you **already have the required token** for the vault that you would like to deposit in:

1. Select the vault that you would like to deposit into.
2. Enter the amount of tokens you want to deposit into the vault. If you are depositing ETH, make sure you have enough ETH left over to pay for future transactions that you might need to make.
1\. Select the vault that you would like to deposit into.

2\. Enter the amount of tokens you want to deposit into the vault. If you are depositing ETH, make sure you have enough ETH left over to pay for future transactions that you might need to make.

<p align="center">
<img width="914.26" height="360.75" src="https://i.imgur.com/LGdRAMQ.png">
</p>

3. Click 'Approve' or 'Deposit' button, depending on if you have previously approved
4. Your wallet will ask you to confirm the transaction. This will take about 3 minutes, but you can speed it up by [paying a higher gas fee to the network](https://blog.leverj.io/how-to-set-the-gas-limit-and-gas-price-in-metamask-1b33c38c32fd). If your transaction gets stuck, see [this guide](https://metamask.zendesk.com/hc/en-us/articles/360015489251-How-to-Speed-Up-or-Cancel-a-Pending-Transaction) on speeding up or cancelling the transaction.
3\. Click 'Approve' or 'Deposit' button, depending on if you have previously approved.

4\. Your wallet will ask you to confirm the transaction. This will take about 3 minutes, but you can speed it up by [paying a higher gas fee to the network](https://blog.leverj.io/how-to-set-the-gas-limit-and-gas-price-in-metamask-1b33c38c32fd). If your transaction gets stuck, see [this guide](https://metamask.zendesk.com/hc/en-us/articles/360015489251-How-to-Speed-Up-or-Cancel-a-Pending-Transaction) on speeding up or cancelling the transaction.

<p align="center">
<img width="258.75" height=" 459.75" src="https://i.imgur.com/BkXBANS.png">
</p>

6. When your transaction succeeds, you will see your deposited balance in the vault's interface, which should appear at the top of the vault list.
5\. When your transaction succeeds, you will see your deposited balance in the vault's interface, which should appear at the top of the vault list.

<p align="center">
<img width="928.5" height="93.75" src="https://i.imgur.com/JvNQ3l2.png">
</p>

When you're ready to withdraw:

1. Select the vault that you would like to withdraw from.
2. Enter the amount you want to withdraw, or click 'Max' to withdraw the entire balance.
1\. Select the vault that you would like to withdraw from.

2\. Enter the amount you want to withdraw, or click 'Max' to withdraw the entire balance.

<p align="center">
<img width="910.5" height="361.5" src="https://i.imgur.com/Y3NsCRb.png">
</p>

3. Click 'Withdraw'
4. Your wallet will ask you to confirm the transaction. See step 4 above for more details.
5. When your transaction succeeds, the tokens will show up in your wallet again
3\. Click 'Withdraw'.

4\. Your wallet will ask you to confirm the transaction. See step 4 above for more details.

5\. When your transaction succeeds, the tokens will show up in your wallet again.

## If you **don't have the required token** for the vault that you would like to deposit in:

Expand All @@ -55,31 +60,39 @@ Thankfully, due to Yearn's 'zap' feature, this can all be done in the same trans

**NOTE:** Zapping a token into a vault will require more transactions than depositing the native token. This means you will be paying more in gas and potentially lose value to slippage when the token is swapped or deposited into a pool. Yearn limits slippage to 1% and the transaction will fail if slippage exceeds that, in which case you will have to swap or deposit the tokens manually. See our [zap](https://docs.yearn.finance/yearn-finance/yvaults/overview#zap-in-with-any-asset) section for more details.

1. Select the crvSTETH vault
2. Click the dropdown box by the 'Approve' or 'Deposit' button
3. Select which token you would like to be converted into crvSTETH. It will only display the tokens that are in your wallet.
1\. Select the crvSTETH vault.

2\. Click the dropdown box by the 'Approve' or 'Deposit' button.

3\. Select which token you would like to be converted into crvSTETH. It will only display the tokens that are in your wallet.

<p align="center">
<img width="909" height="363" src="https://i.imgur.com/6K1luO7.png">
</p>

4. Enter the amount of tokens you would like to deposit and click 'Approve' or 'Deposit' depending on whether or not you have previously approved the token.
4. Confirm the transaction through your wallet. See step 4 in the section above for more details.
5. When your transaction succeeds, you will see your deposited balance in the vault's interface, which should appear at the top of the vault list.
4\. Enter the amount of tokens you would like to deposit and click 'Approve' or 'Deposit' depending on whether or not you have previously approved the token.

5\. Confirm the transaction through your wallet. See step 4 in the section above for more details.

6\. When your transaction succeeds, you will see your deposited balance in the vault's interface, which should appear at the top of the vault list.

When you're ready to withdraw:

1. Select the crvSTETH vault
2. Click the dropdown box by the 'Withdraw' button
1\. Select the crvSTETH vault.

2\. Click the dropdown box by the 'Withdraw' button.

<p align="center">
<img width="915.75" height="600.75" src="https://i.imgur.com/2UyXKN0.png">
</p>

3. Select which asset you would like to receive upon withdrawal. Your options will be the crvSTETH, ETH, BTC, DAI, USDC or USDT
3. Enter the amount you want to withdraw, or click 'Max' to withdraw the entire balance.
4. Confirm the approval if needed, and then approve the withdrawal transaction.
5. When your transaction succeeds, the tokens will show up in your wallet again
3\. Select which asset you would like to receive upon withdrawal. Your options will be the crvSTETH, ETH, BTC, DAI, USDC or USDT.

4\. Enter the amount you want to withdraw, or click 'Max' to withdraw the entire balance.

5\. Confirm the approval if needed, and then approve the withdrawal transaction.

6\. When your transaction succeeds, the tokens will show up in your wallet again.

## Tools to track your funds

Expand Down
0