Skip to content
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
4 changes: 2 additions & 2 deletions docs/contributing/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,8 @@ This is complementary to the above, but it's not directly related to creating st

#### List of Yearn Data Tools

- yDaemon API, [GitHub](https://github.com/yearn/ydaemon)
- Kong API, [GitHub](https://github.com/yearn/kong)
- [yDaemon API](https://docs.yearn.fi/developers/data-services/ydaemon), [GitHub](https://github.com/yearn/ydaemon)
- [Kong API](https://docs.yearn.fi/developers/data-services/kong), [GitHub](https://github.com/yearn/kong)

### Old Legacy Products and Websites

Expand Down
30 changes: 0 additions & 30 deletions docs/contributing/contributor-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,6 @@ Start participating in public discussions by joining the recommended channels be
- Ask for feedback.
- Provide progress updates.

### Meetings

Yearn contributors host meetings when necessary on Google Hangouts. These are not centrally organized and arise organically within discussions between contributors or teams, as such, invitations are up to the individuals organizing these discussions. Invitations are sent to contributors by Discord or Telegram and Google Calendar automatically schedules the event and sends reminders.

- [Jitsi Meet](https://meet.jit.si)
- [Google Meet](https://meet.google.com/_meet)

## Writing Platforms

### HackMD
Expand Down Expand Up @@ -155,29 +148,6 @@ If you are using Google Docs to write, consider using Visual Studio Code and ins
**Pro Tip:**
For a document's final draft, name it "Final draft, moving to GitHub." Post a link to the HackMD file or a relevant page on GitHub.

### Miscellaneous

#### Important Links

- [GitHub Desktop](https://desktop.github.com/)
- [Broken Link Checker](https://ahrefs.com/broken-link-checker)
- [Code Blocks](https://gsuite.google.com/marketplace/app/code_blocks/100740430168?pann=cwsdp&hl=en): for formatting blocks of code in a doc or adding Markdown.
- [Markdown Conversion](https://github.com/lmmx/gdocs2md-html): for Google Drive.
- A long [stack-exchange thread](https://webapps.stackexchange.com/questions/44047/how-can-google-docs-and-markdown-play-nice) on this use case.
- [DrawIO](https://draw.io/): Open source software using Google Drive for creating flowcharts and schemas.
- [Figma](https://www.figma.com/): Creates visual mockups, especially for team collaboration.

#### Wallets and 3rd Party Services

- [Metamask](https://metamask.io/): Wallet for sending and receiving YFI
- [Zerion](https://zerion.io/): For checking Yearn Treasury statistics.

#### Keyboard Shortcuts

- [Mac Shortcuts](https://www.mediaatelier.com/CheatSheet/?ref=producthunt)
- [Windows Shortcuts](https://cheatkeys.com/)
- [Use The Keyboard](https://usethekeyboard.com/): Open-source collection of keyboard shortcuts for Mac apps, Windows programs, and websites.

### Acknowledgments

This document could not be possible without the amazing work done by the MakerDAO team as this document is mostly based on their [Contributor Tools Guide](https://github.com/makerdao/community-portal/blob/r2d/content/en/contribute/content/contributor-tools.mdx).
4 changes: 1 addition & 3 deletions docs/contributing/documentation/working-on-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

Yearn's documentation repository is hosted on GitHub in order to foster and encourage open source collaboration.

_Note for translators: Non-english docs are stored in separate branches. When merging your changes, direct your pull request to the corresponding branch_

## Working with HackMD

In order to contribute to Yearn docs, you will need to be able to write with Markdown syntax. It's extremely easy to learn. Use this [cheat sheet](https://www.markdownguide.org/cheat-sheet/) to get started.
Expand Down Expand Up @@ -88,5 +86,5 @@ Cloning a repository is ideal if you are working on more than one page.

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

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'
15. Make sure the base repository is 'yearn/yearn-devdocs' and the base is 'master'. The head repository should be 'your-username/yearn-devdocs' 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](/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.
2 changes: 1 addition & 1 deletion docs/contributing/documentation/writing-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ When bulleted and numbered lists contain complete sentences, capitalize the firs

### Links

- Use [absolute links](https://docs.microsoft.com/en-us/contribute/how-to-write-links) and standard web URLs when referencing external resources.
- Use [absolute links](https://learn.microsoft.com/en-us/contribute/content/how-to-write-links) and standard web URLs when referencing external resources.
- Create descriptive hyperlinks and avoid generic language.
- **Correct - Descriptive:** Learn more at [Yearn Documentation](https://docs.yearn.fi/)
- **Incorrect - Generic:** Learn more [here](https://docs.yearn.fi/).
Expand Down
13 changes: 6 additions & 7 deletions docs/contributing/governance/governance-and-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,30 @@

Since [YIP-61: Governance 2.0](https://gov.yearn.fi/t/yip-61-governance-2-0/10460) passed on April 25th, 2021, yearn began the transition into a **multi-DAO** structure, managed by **constrained delegation**. This approach allows protocol development not to be stiffened by bureaucracy while maintaining a sufficient level of decentralization.

Multi-DAO refers to the fluid number of decentralized autonomous organizations (DAOs) that contribute to the protocol in some unique way. These independent groups consist of YFI holders, yTeams and the Multisig.
Multi-DAO refers to the fluid number of decentralized autonomous organizations (DAOs) that contribute to the protocol in some unique way. These independent groups consist of stYFI holders, yTeams and the Multisig.

- **YFI holders** vote for changes to the protocol or the governance structure
- **stYFI holders** vote for changes to the protocol or the governance structure
- **yTeams** focus on specific aspects of the protocol or relevant operations
- **Multisig** members execute or veto any onchain decisions

Token holders have an ultimate say over what yTeams exist, who is part of the Multisig, and the limitations of each group's operational control. The term 'constrained delegation' originates from token holders delegating specific powers to various groups building and managing yearn.

A simplified flow of governance would look like this:

1. YFI holders create, destroy and define limitations of yTeams
1. stYFI holders create, destroy and define limitations of yTeams
2. yTeam notifies yTx of a decision
3. yTx creates a delegated transaction and send it to the Multisig
4. Multisig executes or vetos the transaction

With [veYFI](/contributing/governance/veyfi) launch, governance moved from using YFI to veYFI as voting power.
Governance voting power has evolved over time: from YFI, to [veYFI](/contributing/governance/veyfi), and currently [stYFI](/contributing/governance/styfi).

## DAO Responsibilities

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

### Token Holders

[YFI](/contributing/governance/yfi) token-holders duty is to create and vote for proposals that improve the protocol.
[stYFI](/contributing/governance/styfi) token-holders duty is to create and vote for proposals that improve the protocol.


| Proposals | Descriptions |
Expand Down Expand Up @@ -75,7 +75,7 @@ Each yTeam is assigned specific decision-making powers, defined by YIP-61:
| yDev | Add Strategies | Add new strategies to vaults |
| yTx | Delegate Transactions | Create delegated transactions for the multisig to sign and execute |
| yPeople | Pay Team | Create, deploy, modify, or terminate Yearn compensation packages |
| yBudget | Set Budgets | Create budgets for coordinape, grants, hiring, operations, or other workstreams |
| yBudget | Set Budgets | Create budgets for grants, hiring, operations, or other workstreams |
| yFarm | Farm Treasury | Farm with the treasury and make decisions on airdrops |
| yOps | Ratify yTeam Signers | Formally approve or remove signers for each yTeam |

Expand All @@ -96,7 +96,6 @@ Yearn continuously paves the way towards an ideal balance of DAO decentralizatio
- Multisig consensus mechanisms that allow each yTeam to have execution power
- Move from proxy voting to onchain voting
- tokenize decision-making powers as NFTs
- Utilize [Coordinape](https://coordinape.com/) for things like budget allocation and compensation

## Read More

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/governance/migrating-from-veyfi.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Migrate from veYFI

This page covers the **legacy veYFI → current system** migration flow as implemented in the Yearn governance dashboards today.
This page covers the **legacy veYFI → stYFI** migration flow as implemented in the Yearn governance dashboards today.

## Where to migrate

Expand Down
8 changes: 4 additions & 4 deletions docs/contributing/governance/proposal-process.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Proposal Process

[stYFI](/contributing/governance/styfi) token holders govern the Yearn ecosystem through offchain proposals and votes via [Snapshot](https://snapshot.org/#/s:styfi.eth). Proposals that generate majority support (>50% of the vote) are expected to be implemented by the proposed relevant parties. The 9-member [yChad multi-signature wallet](/developers/security/multisig) is then empowered to execute all related transactions after their own review. The [members of the multi-signature wallet](/developers/security/multisig#members) are voted in by YFI holders and are subject to change via future governance votes.
[stYFI](/contributing/governance/styfi) token holders govern the Yearn ecosystem through offchain proposals and votes via [Snapshot](https://snapshot.org/#/s:styfi.eth). Proposals that generate majority support (>50% of the vote) are expected to be implemented by the proposed relevant parties. The 9-member [yChad multi-signature wallet](/developers/security/multisig) is then empowered to execute all related transactions after their own review. The [members of the multi-signature wallet](/developers/security/multisig#members) are voted in by stYFI holders and are subject to change via future governance votes.

## Discussion

Expand Down Expand Up @@ -33,15 +33,15 @@ The default template for proposals can be found on [GitHub](https://github.com/y
**Resources**:

- [Proposal How-To](https://gov.yearn.fi/t/proposal-how-to/106)
- [YIP 0: YIP Purpose and Guidelines](https://yips.yearn.fi/YIPS/yip-0)
- [YIP 44: Improve YIP Categories](https://yips.yearn.fi/YIPS/yip-44)
- [YIP 0: YIP Purpose and Guidelines](/contributing/governance/yips/yip-0)
- [YIP 44: Improve YIP Categories](/contributing/governance/yips/yip-44)
- [YIP 55: Formalize the YIP Introduction and Voting Process](https://gov.yearn.fi/t/yip-55-formalize-the-yip-process/7959)

## Voting

#### How do I vote?

- Holding [veYFI](/contributing/governance/veyfi) enables you to vote on Yearn's [Snapshot](https://snapshot.org/#/s:styfi.eth) page
- Holding [stYFI](/contributing/governance/styfi) enables you to vote on Yearn's [Snapshot](https://snapshot.org/#/s:styfi.eth) page

#### What’s the difference between voting for a poll on the forum and an offchain vote?

Expand Down
Loading
Loading