# We Need Better Docs -- Who Can Help? **URL:** \ **Category:** Feedback\ **Created:** [27 August 2020 09:49 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785 "2020-08-27T09:49:41Z")\ **Posts on this page:** 20\ **Page:** 2
**Author:** ![CryptoOGkauai](https://avatars.discourse-cdn.com/v4/letter/c/a88e4f/32.png) [@CryptoOGkauai](https://gov.yearn.fi/u/CryptoOGkauai)\ **Post date:** [31 August 2020 07:52 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/22 "2020-08-31T07:52:00Z")
I just went in and made edits on HackMD to the Introductory page. I fixed some minor grammatical errors, did some formatting, and added what I hope is information that is concise, relevant, correct and informative. I’m the one that made edits on Sunday night. Feedback or corrections are welcome. Been a busy weekend. I’ve been doing volunteer Tier 1 Tech Support for a ton of new investors on Reddit’s yEarn Finance sub. Subscriptions to the sub exploded this weekend and I was fielding questions left and right. Also, I wrote a guide to depositing LINK, ETH, DAI or USDC for yaLINK that’s on Publish0x: [https://www.publish0x.com/cryptoogkauai/how-to-earn-up-to-52-percent-apy-on-your-link-at-yearn-finan-xjjvpwy](https://www.publish0x.com/cryptoogkauai/how-to-earn-up-to-52-percent-apy-on-your-link-at-yearn-finan-xjjvpwy) ---
**Author:** ![gabriel](https://dub1.discourse-cdn.com/flex013/user_avatar/gov.yearn.fi/gabriel/32/682_2.png) [@gabriel](https://gov.yearn.fi/u/gabriel)\ **Post date:** [31 August 2020 10:23 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/23 "2020-08-31T10:23:51Z")
Hey, I have been making YFI explainer videos. Please check it out and let me know what you think. [![]( " - YouTube") ](https://www.youtube.com/watch?v=m-FZVanYO1w) ---
**Author:** ![CryptoOGkauai](https://avatars.discourse-cdn.com/v4/letter/c/a88e4f/32.png) [@CryptoOGkauai](https://gov.yearn.fi/u/CryptoOGkauai)\ **Post date:** [1 September 2020 05:00 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/24 "2020-09-01T05:00:49Z")
Well done Gabriel. Good job. Finished edits to the Introductory page. All feedback and suggestions are welcome: [https://hackmd.io/tIHBh7bbSzGZHxcDCOkNYQ?view#Introduction](https://hackmd.io/tIHBh7bbSzGZHxcDCOkNYQ?view#Introduction) Next, I will be working on How to Guides including: - How to get started with yEarn and yVaults - How to view and track your deposits - How to withdraw from yEarn and yVaults ---
**Author:** ![Balotelli45](https://avatars.discourse-cdn.com/v4/letter/b/3ec8ea/32.png) [@Balotelli45](https://gov.yearn.fi/u/Balotelli45)\ **Post date:** [2 September 2020 02:11 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/25 "2020-09-02T02:11:51Z")
Can help translate material to French! ---
**Author:** ![gabriel](https://dub1.discourse-cdn.com/flex013/user_avatar/gov.yearn.fi/gabriel/32/682_2.png) [@gabriel](https://gov.yearn.fi/u/gabriel)\ **Post date:** [3 September 2020 08:56 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/26 "2020-09-03T08:56:55Z")
thanks! check this one out [https://youtu.be/nfO95icmSG0](https://youtu.be/nfO95icmSG0) ---
**Author:** ![CryptoOGkauai](https://avatars.discourse-cdn.com/v4/letter/c/a88e4f/32.png) [@CryptoOGkauai](https://gov.yearn.fi/u/CryptoOGkauai)\ **Post date:** [3 September 2020 20:29 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/27 "2020-09-03T20:29:19Z")
I wrote the first and second drafts for our glossary for DeFi and yEarn. To whoever edited the first draft, I’m loving the edits! I’ve never had an editor before for my online writing and I definitely can see the improvements made to that first draft. ---
**Author:** ![CryptoOGkauai](https://avatars.discourse-cdn.com/v4/letter/c/a88e4f/32.png) [@CryptoOGkauai](https://gov.yearn.fi/u/CryptoOGkauai)\ **Post date:** [3 September 2020 20:31 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/28 "2020-09-03T20:31:54Z")
I saw your yETH diagram on twitter. That pic is worth somewhere between 750 and 1250 words, depending on the market conditions. 😄 ---
**Author:** ![sambacha](https://dub1.discourse-cdn.com/flex013/user_avatar/gov.yearn.fi/sambacha/32/1802_2.png) [@sambacha](https://gov.yearn.fi/u/sambacha)\ **Post date:** [4 September 2020 13:23 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/29 "2020-09-04T13:23:03Z")
For formats (re: the actual github repo’s) a branding guide would be really helpful, e.g. here is a proposed “updated” readme for YIPs: [https://gist.github.com/sambacha/9a62174a080ead34271ff5d187a24343](https://gist.github.com/sambacha/9a62174a080ead34271ff5d187a24343) Additionally, I just put out a schema for vaults here: [https://github.com/sambacha/yearn-vault-schema](https://github.com/sambacha/yearn-vault-schema) Here is a “boilerplate” proposed-YIP GitHub repo README file: [https://gist.github.com/sambacha/07c8580377cf7deec6be569322babcfd#file-yip-boilerplate-proposal-md](https://gist.github.com/sambacha/07c8580377cf7deec6be569322babcfd#file-yip-boilerplate-proposal-md) And additionally, here are some Chinese translations of important words for UI/UX, (this is just happens to coincide with what I am doing for work: [https://gist.github.com/sambacha/b34e66f35446f87d43486675c0a24044](https://gist.github.com/sambacha/b34e66f35446f87d43486675c0a24044) ) The reason why I bring up the actual format of the documents is because it will make it much easier to update and keep consistent the documentation across languages (re: git diff’s). Enforcing a format will help with this. For example, here is an attempt at purely using shell scripts to combine all YIPs into one SUMMARY file, [https://github.com/sambacha/YIPS/blob/mdbook/build/YIPS/SUMMARY.md](https://github.com/sambacha/YIPS/blob/mdbook/build/YIPS/SUMMARY.md) you can see that it does not provide useful information as the format for YIPs does not enforce authors to change line titles, etc. This will be important for translation (assuming not using some automated English to \> \* service ) ---
**Author:** ![gabriel](https://dub1.discourse-cdn.com/flex013/user_avatar/gov.yearn.fi/gabriel/32/682_2.png) [@gabriel](https://gov.yearn.fi/u/gabriel)\ **Post date:** [4 September 2020 15:05 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/30 "2020-09-04T15:05:52Z")
thanks, glad you like it. ---
**Author:** ![tracheopteryx](https://dub1.discourse-cdn.com/flex013/user_avatar/gov.yearn.fi/tracheopteryx/32/3979_2.png) [@tracheopteryx](https://gov.yearn.fi/u/tracheopteryx)\ **Post date:** [4 September 2020 15:12 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/31 "2020-09-04T15:12:34Z")
fantastic, thank you. adding to docs v2, will ask for review soon ---
**Author:** ![markjeffrey](https://dub1.discourse-cdn.com/flex013/user_avatar/gov.yearn.fi/markjeffrey/32/646_2.png) [@markjeffrey](https://gov.yearn.fi/u/markjeffrey)\ **Post date:** [4 September 2020 20:00 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/32 "2020-09-04T20:00:43Z")
I’ve started to make $YFi ‘explainer’ videos – and I will continue. This is my first one, explaining Vaults to n00bs. [![]( " - YouTube") ](https://www.youtube.com/watch?v=DKb6VyQxP54) ---
**Author:** ![CryptoOGkauai](https://avatars.discourse-cdn.com/v4/letter/c/a88e4f/32.png) [@CryptoOGkauai](https://gov.yearn.fi/u/CryptoOGkauai)\ **Post date:** [5 September 2020 04:11 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/33 "2020-09-05T04:11:13Z")
Hey can someone please confirm if we’re going with the final spelling of the Lending Aggregator as: “Yearn”, “yEarn” or just" Earn"? And for the vaults it going to be a “Vault” or a “yVault”? This matters because this will be the introductory page for people reading about the project, and will set the template for how it is referenced in all guides and documents going forward. I’d like to get a definite answer on this so we can consider the final Intro Page text and descriptions as a Version 1.0 (or close to it) and move on to helping to write and finish other things. I strongly do _not_ recommend using just “Earn” for the title of the Lending Aggregator as that is already taken by [Crypto.com](http://Crypto.com), a top 12 coin and business, and could lead to confusion amongst CeFi and DeFi investors. ---
**Author:** ![tracheopteryx](https://dub1.discourse-cdn.com/flex013/user_avatar/gov.yearn.fi/tracheopteryx/32/3979_2.png) [@tracheopteryx](https://gov.yearn.fi/u/tracheopteryx)\ **Post date:** [5 September 2020 12:18 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/34 "2020-09-05T12:18:41Z")
working on exactly this! hoping to have something for feedback soon ---
**Author:** ![franklin](https://avatars.discourse-cdn.com/v4/letter/f/3e96dc/32.png) [@franklin](https://gov.yearn.fi/u/franklin)\ **Post date:** [5 September 2020 21:07 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/35 "2020-09-05T21:07:02Z")
Trach and I were discussing this among others. I think we should be moving towards calling it the Yearn ecosystem and away from using yEarn altogether. Not sure where it came from as I don’t recall any initial medium posts or documents. I do recall Andre’s posts specifying yVaults and ySwap and things of that nature, for now we can continue referring them as such. The Introduction page and the documents about a lot of the products are going to get reviewed by some developers, but overall we can keep in mind that current names are subject to change. The “Earn” is derived from how it is presented on the yearn.finance site. I think it would be more appropriate to call it the yPool at curve.finance, which is essentially what it is. Agree, that it probably shouldn’t be called “Earn”, open to feedback. ---
**Author:** ![sambacha](https://dub1.discourse-cdn.com/flex013/user_avatar/gov.yearn.fi/sambacha/32/1802_2.png) [@sambacha](https://gov.yearn.fi/u/sambacha)\ **Post date:** [6 September 2020 15:04 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/36 "2020-09-06T15:04:06Z")
100% behind this, yEarn. Would be nice though to know how capitalization should be enforced. ---
**Author:** ![tracheopteryx](https://dub1.discourse-cdn.com/flex013/user_avatar/gov.yearn.fi/tracheopteryx/32/3979_2.png) [@tracheopteryx](https://gov.yearn.fi/u/tracheopteryx)\ **Post date:** [6 September 2020 15:41 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/37 "2020-09-06T15:41:55Z")
Working on this map with @FutureFund, @franklin and others, very rough still and in-progress but would love feedback. Planning to combine this with some other threads of work and write more details in a forum post asap. ![Screen Shot 2020-09-06 at 5.34.05 PM](https://europe1.discourse-cdn.com/flex013/uploads/yearn/original/2X/a/ae0a9a36e2114723a15988ee18b1fa5b1989aada.jpeg) A critical piece here is clarifying our product line. This model breaks deposit options down into 3 tiers and is informed by how Andre describes yearn on the [Uncommon Core podcasts](https://anchor.fm/uncommoncore/episodes/6-Andre-Cronje-on-Yearn-Finance-ei4vds). Here is that model with a bit of initial copywriting: **yMarkets** : yield-aware dynamic money market (lowest risk) - yDAI, yUSDC, yTUSD, etc. - key legos using for yVaults **yPools** : stablecoin pools of yield-aware money market tokens - yCRV (change to yCURVE or something not “CRV” since it’s not wrapped CRV, it’s an LP) - Opportunity to add new layers here. Swerve anyone? **yVaults** : community-developed autonomous yield farming vaults (higher risk) - yUSD, yLINK, yETH, etc - yUSDC etc Vaults and yTokens need to rename to differentiate from yMarket tier. yUSDCv? Again, this is still rough and early. I’m not loving the Vaults vs yVaults distinction, many other pieces not gelling fully for me either. All feedback and critique is welcome! More soon. ---
**Author:** ![Juanma](https://avatars.discourse-cdn.com/v4/letter/j/bc8723/32.png) [@Juanma](https://gov.yearn.fi/u/Juanma)\ **Post date:** [6 September 2020 20:50 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/38 "2020-09-06T20:50:53Z")
Share it on the subreddit please!! [https://old.reddit.com/r/yearn\_finance/](https://old.reddit.com/r/yearn_finance/) ---
**Author:** ![mdesim01](https://avatars.discourse-cdn.com/v4/letter/m/e99b99/32.png) [@mdesim01](https://gov.yearn.fi/u/mdesim01)\ **Post date:** [10 September 2020 16:21 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/39 "2020-09-10T16:21:43Z")
@tracheopteryx, Well done on the FAQ regarding fees! While reading, I noticed some very minor errors that should be edited They’re bolded and italicized below… "Formerly this was called a “5% fee on subsidized gas” which confused literally everyone except Andre. Technically it is not a performance fee—it’s a fee on _ **the some** _ profit-generating transactions that incur high gas costs and are critical to the vault’s internal functioning. Each vault _ **hasis** _ multiple levels. Here are two examples that show where this fee is taken when the `harvest()` function is called." Otherwise, all looks great to me. Cheers! ---
**Author:** ![tracheopteryx](https://dub1.discourse-cdn.com/flex013/user_avatar/gov.yearn.fi/tracheopteryx/32/3979_2.png) [@tracheopteryx](https://gov.yearn.fi/u/tracheopteryx)\ **Post date:** [10 September 2020 17:24 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/40 "2020-09-10T17:24:50Z")
thanks, not sure how that happened, fixed those typos earlier… ---
**Author:** ![dudesahn](https://dub1.discourse-cdn.com/flex013/user_avatar/gov.yearn.fi/dudesahn/32/4350_2.png) [@dudesahn](https://gov.yearn.fi/u/dudesahn)\ **Post date:** [10 September 2020 18:48 UTC](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785/41 "2020-09-10T18:48:45Z")
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. [Previous page](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785.md?page=1) [Next page](https://gov.yearn.fi/t/we-need-better-docs-who-can-help/3785.md?page=3)