Skip to content

Commit abc6731

Browse files
committed
Merge branch 'master' of https://github.com/yearn/yearn-devdocs
2 parents d59f922 + b509116 commit abc6731

File tree

98 files changed

+923
-3034
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+923
-3034
lines changed

bun.lock

Lines changed: 183 additions & 96 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/contributing/contribute.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,13 @@ If you're a developer, we need your help! Before you begin: Familiarize yourself
4646

4747
If you are interested in working on a specific project, check out the list of Yearn products in the [General Resources](#general-resources) section below or check out our list of repos [here](https://github.com/orgs/yearn/repositories).
4848

49+
If you're not sure where to start or have questions, it's best to join us on the #dev channel in [Discord](https://discord.gg/yearn).
4950

50-
Previously, progress was on our (now deprecated) [GitHub Project Board](https://contribute.yearn.farm/good-first-issue.html). Now, it's better if you join us on the #dev channel in [Discord](https://discord.gg/yearn).
51-
52-
If you want an overview of how our vaults work, please see the schema and accompanying descriptions in the [Vaults Overview](https://docs.yearn.fi/getting-started/products/yvaults/overview).
51+
If you want an overview of how our vaults work, please see the schema and accompanying descriptions in the [Vaults Overview](/getting-started/products/yvaults/overview).
5352

5453
If you're wondering how **strategies** work, please check out [Yearn Vaults v2 Introduction](https://www.youtube.com/watch?v=C0fsYiCI54g) — hosted by our Yearn Devs. To start writing your own strategy, please check out our template [Yearn Brownie Mix](https://github.com/yearn/brownie-strategy-mix).
5554

56-
If you want to integrate with Yearn, please visit our [Integration Guide](https://docs.yearn.fi/partners/integration_guide) and check out our [data services](/developers/data-services/yearn-data/).
55+
If you want to integrate with Yearn, please visit our [Integration Guide](/developers/v3/Integrating_v3) and check out our [data services](/developers/data-services/yearn-data/).
5756

5857
#### Designers
5958

@@ -72,17 +71,9 @@ The best introduction to V2 is the workshop done for Gitcoin Kernel Sessions. Ev
7271

7372
When you decide to start, this reading material is going to come handy:
7473

75-
- [Template for Strategies](https://github.com/yearn/brownie-strategy-mix)
76-
- [Vaults V2 Repository](https://github.com/yearn/yearn-vaults)
77-
- [How to set up coding environment for Yearn Strategies](https://sambacha.github.io/yearn-vaults/index.html)
78-
- [Mint your own DAI](https://medium.com/ethereum-grid/forking-ethereum-mainnet-mint-your-own-dai-d8b62a82b3f7)
79-
- [Dev Docs](https://docs.yearn.fi/developers/v2/getting-started)
80-
81-
Once you have your strategy ready, this will guide you further down the road:
82-
83-
- [Vault naming standard](https://docs.yearn.fi/developers/v2/naming-convention)
84-
- [Release process](https://docs.yearn.fi/developers/v2/DEPLOYMENT)
85-
- [Security check](https://docs.google.com/document/d/1hBKB73kJPQM71enrG8xoSFj7wxYmczUlgigyq2KkcTE/edit#heading=h.4ieoeyetfrxm)
74+
- [Guide to v3 strategies](/developers/v3/strategy_writing_guide)
75+
- [Template for Strategies](https://github.com/yearn/tokenized-strategy-foundry-mix)
76+
- [Vaults V3 Repository](https://github.com/yearn/yearn-vaults-v3)
8677

8778
##### Other reading material
8879

@@ -96,27 +87,30 @@ This is complementary to the above, but it's not directly related to creating st
9687

9788
### Yearn Products
9889

99-
- [yearn.fi](https://yearn.fi/), [GitHub](https://github.com/yearn/yearn-finance-v3)
100-
- [Yearn Documentation](https://docs.yearn.fi/), [GitHub](https://github.com/yearn/yearn-docs)
90+
- [yearn.fi](https://yearn.fi/), [GitHub](https://github.com/yearn/yearn.fi)
91+
- [Yearn Documentation](https://docs.yearn.fi/), [GitHub](https://github.com/yearn/yearn-devdocs)
10192
- [Yearn Governance Forum](https://gov.yearn.fi/)
102-
- [Yearn Snapshot Governance Voting](https://snapshot.org/#/ybaby.eth)
93+
- [Yearn Snapshot Governance Voting](https://snapshot.box/#/s:veyfi.eth)
10394

10495
#### List of Yearn Tools
10596

10697
- Yearn Subgraphs, [Ethereum](https://thegraph.com/explorer/subgraph?id=0xf50b705e4eaba269dfe954f10c65bd34e6351e0c-0&version=0xf50b705e4eaba269dfe954f10c65bd34e6351e0c-0-0&view=Overview), [Fantom](https://thegraph.com/hosted-service/subgraph/yearn/yearn-vaults-v2-fantom), [GitHub](https://github.com/yearn/yearn-vaults-v2-subgraph)
10798
- Yearn SDK, [GitHub](https://github.com/yearn/yearn-sdk)
108-
- [Yearn API](https://ydaemon.yearn.fi/1/vaults/all), [GitHub](https://github.com/yearn/ydaemon)
99+
- Yearn API, [GitHub](https://github.com/yearn/kong)
109100
- Yearn Discord FAQ Bot, [GitHub](https://github.com/danijelthales/yfi-faq-bot)
110101

111102
### Legacy Products and Websites
112103

113104
- Former list of [open GitHub issues here](https://contribute.yearn.rocks/).
114105
- [v1 yearn.fi](https://v1.yearn.fi), [GitHub](https://github.com/yearn/iearn-finance)
115-
- [v2 yearn.fi](https://v2.yearn.fi), [GitHub](https://github.com/yearn/yearn-finance)
106+
- [v2 yearn.fi](https://yearn.fi/vaults), [GitHub](https://github.com/yearn/yearn-finance)
107+
- v3 yearn.fi, [GitHub](https://github.com/yearn/yearn-finance-v3)
116108
- [Yearn Borrow](https://yborrow.finance/), [GitHub](https://github.com/yearn/iborrow-finance)
117109
- [Yearn Governance](https://ygov.finance/), [GitHub](https://github.com/yearn/ygov-finance) - V1 Governance
110+
- [Legacy Yearn Snapshot Governance Voting](https://snapshot.org/#/ybaby.eth)
118111
- [Yearn Newsletter](https://yearn.substack.com/) - Weekly YFI newsletter
119112
- [Trackavault](https://trackavault.com/) - Track V2 Vaults
120113
- [Yearn Watch](https://yearn.watch/), [GitHub](https://github.com/yearn/yearn-watch)
121114
- [YFI Address Stats](https://www.yfistats.com/) - Yearn Financial Information
122115
- [yCosystem (Yearn Community Aggregator)](https://ycosystem.info/) - Repository Of Yearn Links
116+
- [GitHub Project Board](https://contribute.yearn.farm)

docs/contributing/documentation/working-on-docs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Another simple way to contribute is through the built in 'Edit on GitHub' button
4242

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

45-
4. After you 'Propose changes' GitHub will create a branch of the yearn-devdocs 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.fi/contributing/documentation/writing-style-guide), click 'Create pull request'
45+
4. After you 'Propose changes' GitHub will create a branch of the yearn-devdocs repository for you and show a summary of the changes you made. If everything looks right and complies with the [Writing Style Guide](/contributing/documentation/writing-style-guide), click 'Create pull request'
4646

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

@@ -89,4 +89,4 @@ Cloning a repository is ideal if you are working on more than one page.
8989
![](https://i.imgur.com/r8JuC84.jpg)
9090

9191
15. Make sure the base repository is 'yearn/yearn-devdocs' 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-devdocs' and the compare should be 'your-branch-name'
92-
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.fi/contributing/documentation/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.
92+
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](/contributing/documentation/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.

docs/contributing/documentation/writing-style-guide.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ As such, Writers should focus on communicating concepts as clearly and succinctl
5757
- Exclamation points.
5858
- Footnotes.
5959
- References to deprecated names for Yearn Components.
60-
- **Examples:** yyCRV or yUSD instead of yvCurve-Y (see: [Yearn Naming Conventions](https://docs.yearn.fi/developers/v2/naming-convention))
60+
- **Examples:** yyCRV or yUSD instead of yvCurve-Y
6161
- Parentheses for stating additional information
6262
- **Incorrect:** Development Grants are larger sized ($5,000 to $50,000) grants aimed at individuals or teams building projects around vaults and the broader Yearn ecosystem.
6363
- **Correct:** Development Grants are generally larger sized grants, ranging from $5,000 to $50,000, aimed at individuals or teams building projects around vaults and the broader Yearn ecosystem.
@@ -118,10 +118,6 @@ The examples below use dollars, but the same rules apply to all global currencie
118118
- Similarly, when referring to exchange pairs:
119119
- Use: `wETH/DAI`
120120

121-
#### Yearn Products
122-
123-
Please see [Yearn Naming Conventions](https://docs.yearn.fi/developers/v2/naming-convention).
124-
125121
#### Yearn
126122

127123
- When referring to Yearn as a smart contract system, use "The Yearn Protocol."
@@ -256,7 +252,7 @@ Review the respective Contribute.md for each repository where pertinent before s
256252

257253
#### Contributor Tools
258254

259-
- The [Contributor Tools Guide](https://docs.yearn.fi/contributing/contributor-tools) guide introduces the tools regularly used by Yearn contributors.
255+
- The [Contributor Tools Guide](/contributing/contributor-tools) guide introduces the tools regularly used by Yearn contributors.
260256

261257
### Express Interest
262258

docs/contributing/governance/governance-and-operations.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ A simplified flow of governance would look like this:
1919
3. yTx creates a delegated transaction and send it to the Multisig
2020
4. Multisig executes or vetos the transaction
2121

22-
With [veYFI](https://docs.yearn.fi/contributing/governance/veyfi) launch, governance moved from using YFI to veYFI as voting power.
22+
With [veYFI](/contributing/governance/veyfi) launch, governance moved from using YFI to veYFI as voting power.
2323

2424
## DAO Responsibilities
2525

2626
![](https://i.imgur.com/IDysF5O.png)
2727

2828
### Token Holders
2929

30-
[YFI](https://docs.yearn.fi/contributing/governance/yfi) token-holders duty is to create and vote for proposals that improve the protocol.
30+
[YFI](/contributing/governance/yfi) token-holders duty is to create and vote for proposals that improve the protocol.
3131

3232

3333
| Proposals | Descriptions |
@@ -81,7 +81,7 @@ Each yTeam is assigned specific decision-making powers, defined by YIP-61:
8181

8282
### Multisig
8383

84-
Decisions issued by yTeams will be executed on-chain by the Multisig until a more decentralized system is approved for implementation. In the meantime, the [Multisig](https://docs.yearn.fi/developers/security/multisig#members) controls the following:
84+
Decisions issued by yTeams will be executed on-chain by the Multisig until a more decentralized system is approved for implementation. In the meantime, the [Multisig](/developers/security/multisig#members) controls the following:
8585

8686
| Power | Description |
8787
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |

docs/contributing/governance/proposal-process.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Proposal Process
22

3-
[veYFI](https://docs.yearn.fi/contributing/governance/veyfi) token holders control the Yearn ecosystem through off-chain proposals and votes via [Snapshot](https://snapshot.org/#/ybaby.eth). Proposals that generate majority support (>50% of the vote) are implemented by a 9-member multi-signature wallet, and 6 out of 9 wallet signers must sign for a change to be implemented. The [members of the multi-signature wallet](https://docs.yearn.fi/developers/security/multisig#members) were voted in by YFI holders and are subject to change from future governance votes.
3+
[veYFI](/contributing/governance/veyfi) token holders control the Yearn ecosystem through off-chain proposals and votes via [Snapshot](https://snapshot.org/#/ybaby.eth). Proposals that generate majority support (>50% of the vote) are implemented by a 9-member multi-signature wallet, and 6 out of 9 wallet signers must sign for a change to be implemented. The [members of the multi-signature wallet](/developers/security/multisig#members) were voted in by YFI holders and are subject to change from future governance votes.
44

55
## Discussion
66

@@ -22,7 +22,7 @@ Getting as much feedback as possible from the various communication channels is
2222

2323
#### Previous and current proposals
2424

25-
- Previous: [Proposal Repository](https://docs.yearn.fi/contributing/governance/proposal-repository)
25+
- Previous: [Proposal Repository](/contributing/governance/proposal-repository)
2626
- Current: [Snapshot](https://snapshot.org/#/ybaby.eth)
2727

2828
#### Requirements to pass proposals
@@ -49,7 +49,7 @@ The default template for proposals can be found on [GitHub](https://github.com/y
4949

5050
#### How do I vote?
5151

52-
- Holding [veYFI](https://docs.yearn.fi/contributing/governance/veyfi) enables you to vote on Yearn's [Snapshot](https://snapshot.org/#/ybaby.eth) page
52+
- Holding [veYFI](/contributing/governance/veyfi) enables you to vote on Yearn's [Snapshot](https://snapshot.org/#/ybaby.eth) page
5353

5454
#### What’s the difference between voting for a poll on the forum and an off-chain vote?
5555

@@ -61,4 +61,4 @@ Once a Snapshot votes have passed, changes will be implemented by Yearn's protoc
6161

6262
## Guardian Role
6363

64-
Per [YIP-81](https://snapshot.box/#/s:veyfi.eth/proposal/0x6f3082db2cef3e0c254e569580d063cb14130a92d0bf1729bef342a386e419f2), the [Yearn Multisig](https://docs.yearn.fi/developers/security/multisig) (AKA yChad) serves in the Guardian role to steward and protect the Yearn Protocol and its participants. The Guardian role is defined as being able to **"nullify a proposal or governance decision but cannot make proposals"**.
64+
Per [YIP-81](https://snapshot.box/#/s:veyfi.eth/proposal/0x6f3082db2cef3e0c254e569580d063cb14130a92d0bf1729bef342a386e419f2), the [Yearn Multisig](/developers/security/multisig) (AKA yChad) serves in the Guardian role to steward and protect the Yearn Protocol and its participants. The Guardian role is defined as being able to **"nullify a proposal or governance decision but cannot make proposals"**.

docs/contributing/governance/veYFI-comp-summary.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -291,18 +291,14 @@ For users who prefer not to manage individual locks and veYFI decay, **liquid lo
291291

292292
### Contract Addresses
293293

294-
- **[Yearn veYFI Contract Addresses](/developers/addresses/veyfi-contract)**
294+
- **[Yearn veYFI Contract Addresses](/developers/addresses/veyfi-contracts)**
295295

296296
### Audits
297297

298298
- **[veYFI StateMind Audit](https://github.com/yearn/yearn-security/blob/master/audits/202208_yAcademy_yearn-veyfi/yAcademy_-_yearn_veyfi_review.pdf)**
299299
- **[veYFI yAcademy Audit](https://github.com/yearn/yearn-security/blob/master/audits/202208_yAcademy_yearn-veyfi/yAcademy_-_yearn_veyfi_review.pdf)**
300300
- **[dYFI ChainSecurity Audit](https://old.chainsecurity.com/wp-content/uploads/2023/03/Yearn-Smart-Contract-Audit-oYfi-ChainSecurity.pdf)**
301301

302-
### Other Resources
303-
304-
- **[veCRV Explained](https://resources.curve.finance/vecrv/overview/)**
305-
306302
---
307303

308304
*This document is intended to provide a detailed understanding of the veYFI and dYFI mechanisms within Yearn Finance. Users are encouraged to participate actively in governance and stay informed about ongoing developments.*

docs/contributing/governance/veYFI-intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Locking YFI for veYFI has 3 main benefits: Voting power, Yield boosts on funds d
88

99
### veYFI Voting
1010

11-
veYFI is the governance token of Yearn. It is used to vote on YFI emissions distributions and other governance items in [snapshot](https://snapshot.org/#/veyfi.eth). For more information on Yearn's governance process, head over to the [governance section of the docs](https://docs.yearn.fi/contributing/governance/proposal-process).
11+
veYFI is the governance token of Yearn. It is used to vote on YFI emissions distributions and other governance items in [snapshot](https://snapshot.org/#/veyfi.eth). For more information on Yearn's governance process, head over to the [governance section of the docs](/contributing/governance/proposal-process).
1212

1313
### veYFI Yield Boosts on Yearn Deposits
1414

docs/contributing/governance/yfi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ YDPs are proposals that change where any discrete decision-making power is deleg
4848

4949
## veYFI
5050

51-
With [veYFI](https://docs.yearn.fi/contributing/governance/veyfi) launch, governance changed from using YFI to veYFI as voting power.
51+
With [veYFI](/contributing/governance/veyfi) launch, governance changed from using YFI to veYFI as voting power.

docs/contributing/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Yearn is a collective of developers, users, thinkers, and doers all working towa
66

77
## Governance
88

9-
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](https://docs.yearn.fi/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).
9+
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](/developers/security/multisig) for the list of multisig signers. For more info about the governance process, please consult the [multisig members list](/developers/security/multisig) and [YIP-61: Governance 2.0](https://gov.yearn.fi/t/yip-61-governance-2-0/10460).

0 commit comments

Comments
 (0)