DevDocs 2025 Q1 Budget Request

[rossgalloway]

Scope

This budget request is to continue the Yearn documentation effort. I have worked as the devdocs maintainer for the last 9 months (last BR and report here) and would like to continue with my efforts to improve and expand upon Yearn's documentation.

I will continue to maintain and improve Yearn's documentation and knowledge base, including continuing to stay in contact with those building V3-Vaults, yLockers, yETH, veYFI, yDaemon, the subgraphs, and any other initiatives that need documentation. I will continue with my efforts to improve the flow and usefulness of the docs for all users and contributors.

Plan

Baseline Tasks:

• Continue to learn about Yearn's documentation and organizational structure to improve all aspects of documentation. This involves research and discussions with contributors about different parts of Yearn as I update the documentation on those elements.
• Continue to maintain the current yearn-devdocs while adding and improving the documentation for new products (vaults v3, yETH, yLockers, yPools, etc.)
• Work with ySupport to keep User guides up to date and relevant
• Continue to maintain and improve the backend infrastructure for the docs. Keep dependencies up to date and add new features as needed. Fix any and all bugs as they pop up.

General Issues/Improvements

• Continue implementing automatic checks of important contract addresses against registries, ENS names, and/or other sources. Projects still requiring automatic checks are:
  • yVaults V2
  • yPools
  • yLockers
• Work on improving the automation for automatic checks. See this Issue
• Finish yPools docs update. See draft PR here
• Incorporate basic yDaemon documentation into the docs.
• Coordinate with MT on Kong docs.
• Fix github linter check that always fails on deploy when relative links are used. (low priority)
• Update V3 Vault user guides to reflect changes to interface.

Other Work and Improvements

The above does not take up all of my time, so I have found myself working on other "Docs-adjacent" projects that I believe will benefit Yearn. In the last BR that was a Yearn Dashboard and a veYFI Boost Calculator. This BR I hope to be a little more ambitious, build on these projects, and also synergize with the other BR that I am proposing here.

SuperDocs

Yearn feels like it is at a crossroads. The future of the websites and dapps is unclear and the overall direction of the organization is being debated. The docs are a minor part of this conversation, but I believe that they are positioned to take a greater role in how users interact with Yearn.

I believe that there is a need to provide a more data heavy, professional style interface for Yearn. Something that lives in between the current yearn.fi site and etherscan, and can provide power users the tools they need to invest with confidence using Yearn products.

The bones to create this interface with the docs are there:

• The docs are already built with Docusaurus, which is an overlay over React and allows anything to be built. It is just a React site
• I have integrated RPC call functionality using viem to get live on-chain data as needed. It is only a short step to integrating rainbow kit and wagmi.
• The charts from https://yearn-dashboard-plum.vercel.app/ aren't perfect, but they could easily be added to the docs.
• Once the charts exist in Docs, each vault has a homepage there. I can add deposit and withdrawal widgets.

I don't expect this to take the place of yearn.fi. That requires a level of reliability that may be better left to a more experienced developer. But it can certainly serve as a backup (one that will rely on Kong and not yDaemon as its primary data dependency), and as a testing ground for different UX ideas that can be incorporated into other sites if they are deemed successful. Maybe one day it can be an interface to stand alongside yearn.fi, but I don't expect that for a while.

I will start incrementally. Rough steps to begin are:

• Proof of concept wallet connector
• Organizational change to move Docs and Tools/Dapp into separate sections
• Testing concept with an interface to withdraw funds from V1 vaults, which is a relatively common issue ySupport fields and they default to etherscan.
• Refactor docs codebase to use tailwind (or at least be forward compatible with it) so that components can interoperate between other dapps Yearn maintains (They all use tailwind)

see last quarter's report for mockup screenshots of what I am envisioning.

Deadline

Apr. 30 2025

People

@rossgalloway
@MarcoWorms

Money

Monthly:

• 8.9k USDC in yvUSDC, per month.

  Split:

  • 6.9k USDC per month, for @rossgalloway (maintainer)
  • 2k USDC per month, for @MarcoWorms (reviewer and misc. shit shoveller)

Lump Sum:

• 500 USDC total for discourse forum subscription. This service is provided at cost.

Amount (Total)

(8900 * 3) + 500 = 27,200

Wallet address

0xA7b6f3d18db39F65C8056d0892Af76c07d15Fc5a

Reporting

Once