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

Feat: Add new FAQ to guides section #482

Merged
merged 8 commits into from
Dec 12, 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
43 changes: 43 additions & 0 deletions docs/getting-started/guides/user-faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Frequently Asked Questions

<details className="customFaqDetails">

<summary>

## I don't see my deposit, where is it?

</summary>

If you deposited into a Yearn Vault and then click the "withdraw" tab and don't see your tokens, don't worry, they are probably staked!

The default "deposit" action in yVaults with a gauge or other extra rewards is to deposit your tokens in the yVault and stake the yVault token for extra rewards. To see your yVault tokens, click on the "veYFI BOOST" tab (it may be named something else like "staking BOOST") next to the withdraw tab. You should be able to un-stake your vault tokens there and then withdraw.

![Withdraw modal](/img/guides/FAQ/unstake.png)

### Update your default deposit settings

If you want to change the default deposit behavior to only deposit and not also stake the vault tokens, you can change that setting by clicking on the gear icon to the right of the tabs and unchecking "stake automatically" at the bottom of the menu that opens up.

![deposit setting](/img/guides/FAQ/deposit-setting.png)

</details>

<details className="customFaqDetails">

<summary>

## My veYFI rewards are lower than expected, Why?

</summary>

veYFI rewards are variable depending on how much veYFI your wallet holds. If you don't have veYFI, you will only get 10% of the maximum reward amount shown. In the image below, note the range of rewards APY. Without any veYFI, a deposit will earn a 1.16% boost, paid in dYFI.

![apy-range](/img/guides/FAQ/boostAPY.png)

If you don't have veYFI, you can deposit and stake your tokens using liquid lockers. By doing this you use the liquid locker's veYFI to boost your deposit.

Read more about veYFI, boosts, dYFI and liquid lockers on the [veYFI page](/contributing/governance/veYFI-intro)

And remember, you have to consider transaction costs when using Yearn. If using Ethereum mainnet, prices for transactions vary from a few dollars to tens or hundreds of dollars, depending on chain congestion (Yearn has no control over this). If you are depositing lower amounts (\<$500-1000), you may want to consider using Yearn on an L2 so fees don't negate your interest earned.

</details>
2 changes: 1 addition & 1 deletion docs/getting-started/products/yvaults/yvaults-faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# yVaults FAQ

<details open className="customFaqDetails">
<details className="customFaqDetails">

<summary>

Expand Down
1 change: 1 addition & 0 deletions sidebars/sidebarsUserDocs.js
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ module.exports = {
type: 'category',
label: 'Guides',
items: [
'guides/user-faq',
'guides/using-yearn-v3',
'guides/using-yearn-v2',
'guides/how-boost-works',
Expand Down
2 changes: 1 addition & 1 deletion src/components/PrettyLink.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import Link from '@docusaurus/Link'
export default function PrettyLink({ children }) {
return (
<Link to={children.props.href} className={styles.prettylink}>
<div className={styles.textContainer}>{children.props.children}</div>
<span className={styles.textContainer}>{children.props.children}</span>
</Link>
)
}
36 changes: 36 additions & 0 deletions src/theme/DocItem/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import React from 'react'
import { useEffect } from 'react'
import DocItem from '@theme-original/DocItem'

export default function DocItemWrapper(props) {
const handleHashChange = () => {
const hash = decodeURIComponent(window.location.hash)
if (hash) {
const heading = document.querySelector(hash)
if (heading) {
const details = heading.closest('details')
if (details) {
details.open = true
details.removeAttribute('data-collapsed')
details.querySelector('summary').click()
}
}
}
}

useEffect(() => {
handleHashChange() // Run on initial load

window.addEventListener('hashchange', handleHashChange) // Run on hash change

return () => {
window.removeEventListener('hashchange', handleHashChange)
}
}, [])

return (
<>
<DocItem {...props} />
</>
)
}
Binary file added static/img/guides/FAQ/boostAPY.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/guides/FAQ/deposit-setting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/guides/FAQ/unstake.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading