We Need Better Docs -- Who Can Help?

General Chat Feedback
41

I would change “vaults” in the flow to something else. Perhaps “Yield”? I think having “yVaults” as a dependent of “Vaults” is too confusing.

For the naming convention, so that it makes sense to newcomers, I think all of the vault tokens should have a prefix– perhaps “yv”? Also, are there any chances we fill out the yPools and the yMarkets? Once tokenized BTC is common enough, I could certainly see a similar yPool with several types of BTC that lend out the best market and also earns trading fees (just like the stablecoin Y pool does on Curve). Thinking of this, it also may be worth denoting these with the prefix “yp”. In this case, it also might make sense for the yCRV/yCURVE to instead be ypUSD– since these are stablecoins, not some curve token– it just happens to be hosted on curve as the trading market.

Summary:
Change “Vaults” to “Yield” or something else.
yMarkets: yDAI, yUSDC, yTUSD, etc
yPools: ypUSD, ypBTC (potentially, eventually)
yVaults: yvUSD, yvETH, yvDAI, etc

This way, the second someone sees a specific Yearn token name– they will know exactly what it does and where it belongs in the ecosystem.

1 Like
42

Latest thinking is get rid of these sub-Vaults names (yMarkets, yPools). It’s all Vaults of different flavors. Still working through ecosystem naming conventions (eg yVaults vs just Vaults).

43

I wouldn’t rename Vaults, that’s a well-known and well-liked name and it’s working well for us. The token schema is actually not bad as is I think:

All Vaults (including Earn): yTOKEN
yInsure: yiTOKEN
StableCredit: scTOKEN

I’d love to change yCRV though if we could. The only other problem is differentiating between yUSDC that comes from the older Earn contract and the yUSDC that comes from the newer vault. But that’s not different from the various flavors of BPT, for example. And the older stuff is mostly just used as legos for the newer stuff, so token renaming is likely just bikeshedding. The product naming is important though IMO.

44

Yeah, definitely didn’t want to get rid of the terms “Vaults” in general– I just thought that having “yVaults” as a subset of “Vaults” would be very confusing.

And fair enough on wanting to keep it simple with yTOKEN for all vaults– I supposed it’s also highly unlikely we actually do create a Y pool of BTC, since this is basically what the sBTC pool currently is anyway. I suppose my only question is, stylistically, how do we differentiate between something like yDAI (original earn) and yDAI (Vault). Especially if we’re referring to both of these as vaults now.

I definitely do think the yCRV name has to go, though. It’s too confusing with Curve having their own token.

Possible options to replace yCRV:

  1. yPOOL– points to the fact that it is a pool of stablecoins, and will likely remain Yearn’s primary money pool that we build off of. Also feels less composed than yUSD, which I like. It’s sort of like yUSD is the final form, and the yPOOL helps support it as a pool of stablecoins beneath it.
  2. ySTABLE
  3. yCURVE (as you suggested above)

yPOOL is my favorite I think, because of the reasons above.

2 Likes
45

We just put new version of docs up. Should be much cleaner than previous one.

People are welcome to submit PR if they find typos/broken links or mistakes.

4 Likes