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

fix old domain links #346

Merged
merged 3 commits into from
Sep 4, 2023
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The following is a set of guidelines for contributing to Yearn's Dev Docs, which
- [Yearn Finance on GitHub](https://github.com/yearn/)
- [Twitter](https://twitter.com/iearnfinance)
- [Discord](https://discord.gg/yearn/)
- [Discourse](https://gov.yearn.finance/)
- [Discourse](https://gov.yearn.fi/)

## High Level Contributing Workflow

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Yearn Protocol Documentation Website

The yearn devdocs [website](https://docs.yearn.finance/) is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
The yearn devdocs [website](https://docs.yearn.fi/) is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

## Installation

Expand Down
34 changes: 17 additions & 17 deletions docs/contributing/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

## Yearn Contributors

Help build the future of finance, shape your skills, and grow the Yearn ecosystem. Before joining our community, take some time to understand the philosophy behind Yearn through the [The Bluepill](https://yfistory.org/thebluepill) and [Yearn Manifesto](https://gov.yearn.finance/t/how-we-think-about-yearn/7137).
Help build the future of finance, shape your skills, and grow the Yearn ecosystem. Before joining our community, take some time to understand the philosophy behind Yearn through the [The Bluepill](https://yfistory.org/thebluepill) and [Yearn Manifesto](https://gov.yearn.fi/t/how-we-think-about-yearn/7137).

## How to Contribute

### Have an idea?

We are always open to new suggestions or better ways of doing things. If you have an idea feel free to use the appropriate channel on [Discord](https://discord.gg/yearn), [Reddit](https://www.reddit.com/r/yearn_finance/), make a post on the governance [forum](https://gov.yearn.finance/c/general-chat/7), or consider adding to the [Pool of Ideas](https://yearnfinance.notion.site/Pool-of-Ideas-d75383ade9154d8bb6163388c6c2b39b). If the idea is thorough enough, make a post in the [Proposals](https://gov.yearn.finance/c/proposals/5) section on the governance forum. Be sure to follow the Proposal [Guidelines](https://gov.yearn.finance/t/proposal-how-to/106) and check previous [YIPs](https://yips.yearn.finance/all-yip) for guidance.
We are always open to new suggestions or better ways of doing things. If you have an idea feel free to use the appropriate channel on [Discord](https://discord.gg/yearn), [Reddit](https://www.reddit.com/r/yearn_finance/), make a post on the governance [forum](https://gov.yearn.fi/c/general-chat/7), or consider adding to the [Pool of Ideas](https://yearnfinance.notion.site/Pool-of-Ideas-d75383ade9154d8bb6163388c6c2b39b). If the idea is thorough enough, make a post in the [Proposals](https://gov.yearn.fi/c/proposals/5) section on the governance forum. Be sure to follow the Proposal [Guidelines](https://gov.yearn.fi/t/proposal-how-to/106) and check previous [YIPs](https://yips.yearn.fi/all-yip) for guidance.

### Ready to contribute?

Expand All @@ -28,17 +28,17 @@ If the issue already exists, you can signal your support by adding a thumbs up t

### Leave Feedback

Use the [Feedback](https://gov.yearn.finance/c/feedback/2) section of the governance forum to provide feedback.
Use the [Feedback](https://gov.yearn.fi/c/feedback/2) section of the governance forum to provide feedback.

### Write Documentation

The Yearn ecosystem is expanding and, as a result, so is the need for documentation. You can find the "official" Yearn Documentation [here](https://docs.yearn.finance/) — which provides high-level overviews _and_ technical documentation.
The Yearn ecosystem is expanding and, as a result, so is the need for documentation. You can find the "official" Yearn Documentation [here](https://docs.yearn.fi/) — which provides high-level overviews _and_ technical documentation.

Whether it's writing _How To_ guides on using vaults or creating diagrams on how the protocol ties together, there is something for everyone. If you speak another language, translations might be up your alley!

You can see our progress on the [Github Project Board](https://github.com/orgs/yearn/projects/2) where you can look through any issue that interests you. Before contributing: Please see our [How to Use Github](https://hackmd.io/4U35op0ORoGT24lzPhbGNQ) guide and ensure that your PRs adhere to our [Writing Style Guide](https://hackmd.io/dXQecpkJQX6XRy4y7k7j3g).

We use a combination of HackMD, Docusaurus, and Github for our [Documentation](https://docs.yearn.finance/) and we use [DrawIO](https://draw.io) with Google Drive for our diagrams & schemas. If you are a grammar stickler, you can see our [Reviewer Guide](https://hackmd.io/juTKNn3xTpKJgFDo2AglLw).
We use a combination of HackMD, Docusaurus, and Github for our [Documentation](https://docs.yearn.fi/) and we use [DrawIO](https://draw.io) with Google Drive for our diagrams & schemas. If you are a grammar stickler, you can see our [Reviewer Guide](https://hackmd.io/juTKNn3xTpKJgFDo2AglLw).

Last but not least, join the #documentation channel in [Discord](https://discord.gg/freT6YRNSX) and introduce yourself.

Expand All @@ -48,17 +48,17 @@ If this sounds confusing, please let us know what we can clear up. In the meanti

#### Developers

If you're a developer, we need your help! Before you begin: Familiarize yourself with Yearn, its products, and its infrastructure by reading our [Documentation](https://docs.yearn.finance/).
If you're a developer, we need your help! Before you begin: Familiarize yourself with Yearn, its products, and its infrastructure by reading our [Documentation](https://docs.yearn.fi/).

You can see our progress on our [Github Project Board](https://contribute.yearn.farm/good-first-issue.html), and you can immediately begin contributing where you see fit. We recommend checking out issues tagged as `help wanted` and recommend sticking to the respective repository's coding guidelines (linting, formatting, PRs, etc). It's that simple 🙂. You can also join us on the #dev channel in [Discord](https://discord.gg/w89vVxeV9h).

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

If you want an overview of how our vaults work, please see the schema and accompanying descriptions in the [Vaults Overview](https://docs.yearn.finance/getting-started/products/yvaults/overview).
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).

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

If you want to integrate with Yearn, please visit our [Integration Guide](https://docs.yearn.finance/partners/integration_guide) and check out our [Vault API Documentation](https://docs.yearn.finance/vaults/smart-contracts/VaultAPI).
If you want to integrate with Yearn, please visit our [Integration Guide](https://docs.yearn.fi/partners/integration_guide) and check out our [Vault API Documentation](https://docs.yearn.fi/vaults/smart-contracts/VaultAPI).

#### Designers

Expand All @@ -81,12 +81,12 @@ When you decide to start, this reading material is going to come handy:
- [Vaults V2 Repository](https://github.com/yearn/yearn-vaults)
- [How to set up coding environment for Yearn Strategies](https://sambacha.github.io/yearn-vaults/index.html)
- [Mint your own DAI](https://medium.com/ethereum-grid/forking-ethereum-mainnet-mint-your-own-dai-d8b62a82b3f7)
- [Dev Docs](https://docs.yearn.finance/developers/v2/getting-started)
- [Dev Docs](https://docs.yearn.fi/developers/v2/getting-started)

Once you have your strategy ready, this will guide you further down the road:

- [Vault naming standard](https://docs.yearn.finance/developers/v2/naming-convention)
- [Release process](https://docs.yearn.finance/developers/v2/DEPLOYMENT)
- [Vault naming standard](https://docs.yearn.fi/developers/v2/naming-convention)
- [Release process](https://docs.yearn.fi/developers/v2/DEPLOYMENT)
- [Security check](https://docs.google.com/document/d/1hBKB73kJPQM71enrG8xoSFj7wxYmczUlgigyq2KkcTE/edit#heading=h.4ieoeyetfrxm)

##### Other reading material
Expand All @@ -101,17 +101,17 @@ This is complementary to the above, but it's not directly related to creating st

### Yearn Products

- [Yearn.Finance](https://yearn.finance/), [Github](https://github.com/yearn/yearn-finance-v3)
- [Yearn Documentation](https://docs.yearn.finance/), [Github](https://github.com/yearn/yearn-docs)
- [Yearn Governance Forum](https://gov.yearn.finance/)
- [yearn.fi](https://yearn.fi/), [Github](https://github.com/yearn/yearn-finance-v3)
- [Yearn Documentation](https://docs.yearn.fi/), [Github](https://github.com/yearn/yearn-docs)
- [Yearn Governance Forum](https://gov.yearn.fi/)
- [Yearn Snapshot Governance Voting](https://snapshot.org/#/ybaby.eth)

#### List of Yearn Tools

- [Yearn Watch](https://yearn.watch/), [Github](https://github.com/yearn/yearn-watch)
- 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)
- Yearn SDK, [Github](https://github.com/yearn/yearn-sdk)
- [Yearn API](https://api.yearn.finance/v1/chains/1/vaults/all), [Github](https://github.com/yearn/yearn-api)
- [Yearn API](https://api.yearn.fi/v1/chains/1/vaults/all), [Github](https://github.com/yearn/yearn-api)
- [Yearn Vision](https://yearn.vision/)
- Yearn Discord FAQ Bot, [Github](https://github.com/dgornjakovic/yfi-faq-bot)

Expand All @@ -123,7 +123,7 @@ This is complementary to the above, but it's not directly related to creating st
- [Trackavault](https://trackavault.com/) - Track V2 Vaults

### Legacy Products and Websites
- [v1 Yearn.Finance](https://v1.yearn.finance), [Github](https://github.com/yearn/iearn-finance)
- [v2 Yearn.Finance](https://v2.yearn.finance), [Github](https://github.com/yearn/yearn-finance)
- [v1 yearn.fi](https://v1.yearn.fi), [Github](https://github.com/yearn/iearn-finance)
- [v2 yearn.fi](https://v2.yearn.fi), [Github](https://github.com/yearn/yearn-finance)
- [Yearn Borrow](https://yborrow.finance/), [Github](https://github.com/yearn/iborrow-finance)
- [Yearn Governance](https://ygov.finance/), [Github](https://github.com/yearn/ygov-finance) - V1 Governance
4 changes: 2 additions & 2 deletions docs/contributing/documentation/working-on-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Another simple way to contribute is through the built in 'Edit on GitHub' button

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

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.finance/contributing/documentation/writing-style-guide), click 'Create pull request'
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'

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.

Expand Down Expand Up @@ -91,4 +91,4 @@ 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'
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/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.
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.
10 changes: 5 additions & 5 deletions docs/contributing/documentation/writing-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ As such, Writers should focus on communicating concepts as clearly and succinctl
- Exclamation points.
- Footnotes.
- References to deprecated names for Yearn Components.
- **Examples:** yyCRV or yUSD instead of yvCurve-Y (see: [Yearn Naming Conventions](https://docs.yearn.finance/developers/v2/naming-convention))
- **Examples:** yyCRV or yUSD instead of yvCurve-Y (see: [Yearn Naming Conventions](https://docs.yearn.fi/developers/v2/naming-convention))
- Parentheses for stating additional information
- **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.
- **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.
Expand Down Expand Up @@ -120,7 +120,7 @@ The examples below use dollars, but the same rules apply to all global currencie

#### Yearn Products

Please see [Yearn Naming Conventions](https://docs.yearn.finance/developers/v2/naming-convention).
Please see [Yearn Naming Conventions](https://docs.yearn.fi/developers/v2/naming-convention).

#### Yearn

Expand Down Expand Up @@ -176,8 +176,8 @@ When bulleted and numbered lists contain complete sentences, capitalize the firs

- Use [absolute links](https://docs.microsoft.com/en-us/contribute/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.finance/)
- **Incorrect - Generic:** Learn more [here](https://docs.yearn.finance/).
- **Correct - Descriptive:** Learn more at [Yearn Documentation](https://docs.yearn.fi/)
- **Incorrect - Generic:** Learn more [here](https://docs.yearn.fi/).
- Include a `.`outside the link for sentences that end with a link.
- When creating links for parallel translated documents, make sure to update relative links to reflect the correct heading.

Expand Down Expand Up @@ -256,7 +256,7 @@ Review the respective Contribute.md for each repository where pertinent before s

#### Contributor Tools

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

### Express Interest

Expand Down
8 changes: 4 additions & 4 deletions docs/contributing/governance/governance-and-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

---

Since [YIP-61: Governance 2.0](https://gov.yearn.finance/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.
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.

Expand All @@ -19,15 +19,15 @@ A simplified flow of governance would look like this:
3. yTx creates a delegated transaction and send it to the Multisig
4. Multisig executes or vetos the transaction

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

## DAO Responsibilities

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

### Token Holders

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


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

### Multisig

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.finance/resources/faq#who-is-on-the-multisig) controls the following:
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/resources/faq#who-is-on-the-multisig) controls the following:

| Power | Description |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down
Loading