Skip to content

Conversation

@Kilniv
Copy link

@Kilniv Kilniv commented Nov 28, 2021

Reading through the docs I noticed some incorrect sentences and other elements that I thought would benefit from being reviewed. Some of the changes aim to streamline elements across the document. E.g. by conforming the sentence construction of all entries in a list.

If welcome, I will review the other sections (Governance, OPTY and User Guides) in the future.

The sentence "Yield was the "killer application" that brought DeFi to the world's attention. But we are still at a very early stage. "
needs further updating.
About the sentence: "The nodes of the Strategy Graph represent liquidity pools and the inbound edges represent deposits into those liquidity pools."
would it not be better to define deposits as 'strategy steps' or 'actions performed by strategy sequences'?
Copy link

@NouDaimon NouDaimon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checklist:
-Ensure voice is consistent throughout
-Ensure meaning is not changed and is perfectly aligned with current structure/application of the protocol.
-Reduce as much as possible repetition of words.

Vaults are OptyFi smart contracts into which users deposit assets in order to get these assets deployed into strategies. Vaults enable users to share gas costs and thereby increase user profitability while also enabling more frequent strategy switching.

Each vault has a [vault type](vaults.md#vault-types) determined by its underlying token \(i.e. the token users would deposit into the vault\). Each vault is also associated with a specific [risk profile](risk-framework.md#risk-profiles) which determines which strategies the vault can and cannot deploy assets into.
Each vault has a [vault type](vaults.md#vault-types) determined by its [underlying token](tokens-and-pools.md#tokens) \(i.e. the token users would deposit into the vault\). Each vault is also associated with a specific [risk profile](risk-framework.md#risk-profiles) which determines which strategies the vault can and cannot deploy assets into.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recommendation:
...which determines which strategies the vault is permitted to deploy assets into.

There will be a separate vault for each underlying asset and risk profile combination.

Upon launch \(ETA July 2021\), the following vaults will be deployed.
Upon launch, the following vaults will be deployed:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change:
Upon Alpha launch,....

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would probably be more correc to change this to launch? Or beta launch maybe?
For now, I've changed it to 'During the alpha phase'.

### Factor-Based and Thematic Yield Investing

By explicitly defining the universe of discrete yield strategies, OptyFi enables application of the principles of factor-based investing and thematic investing to yield generation. Thus, instead of only trying to optimize for APY, strategists can optimize strategies based on exposure to various factors and yield portfolios can be developed that specify weight exposures to specific factors. Of course risk could be a primary factor, but almost any factor can be defined such as exposure to pool type \(e.g. DEX, Lending, Derivatives\) or exposure to protocol age. Similarly, vaults can be configured to invest thematically, for example to invest only in liquidity pools related to Ethereum L2 scaling solutions.
By explicitly defining an assortment of discrete yield strategies, OptyFi enables application of the principles of factor-based investing and thematic investing to yield generation. Thus, instead of only trying to optimize for APY, strategists can optimize strategies based on exposure to various factors and yield portfolios can be developed that specify weight exposures to specific factors. Theoretically, all factors can be utilized to determine a strategy, such as exposure to pool type \(e.g. DEX, Lending, Derivatives\) or exposure to protocol age. Similarly, vaults can be configured to invest thematically, for example, by investing only in liquidity pools related to Ethereum L2 scaling solutions.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recommendation:
-...explicitly defining an all-inclusive ensemble of ...
-...exposure to various factors, thus yield
-Theoretically, almost any factor can....

Change:
-"By investing" ---> investment only....

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change:
-"By investing" ---> investment only....
would result in an incorrect sentence for me. I have left it as is for now.

@Kilniv
Copy link
Author

Kilniv commented Dec 2, 2021

Hello NouDaimon,
Thank you for the clear and in-depth feedback. It is obvious the team is interested to further perfect the docs. I will get to your feedback in the coming days. Furthermore, I will expand this merge request to include all parts of the documentation.

I hope to improve suggested edits as I become more familiar with the project.

Cheers

@Kilniv
Copy link
Author

Kilniv commented Dec 12, 2021

On the matter of proposals, I would recommend changing 'normal proposal' to 'standard proposal'.

@Kilniv Kilniv changed the title Review docs (Intro; Protocol) Review docs (Intro; Protocol; Governance; OPTY) Dec 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants