DevDocs 2024 Q4 Budget Request

[rossgalloway]

Scope

This budget request is to continue the Yearn documentation effort. I have worked as the devdocs maintainer for the last 6 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.

In the last quarter I implemented numerous visual and organizational upgrades to the docs with the goal of making them more user friendly for both Yearn users and Developers building on top of Yearn. I have also been working on streamlining the docs maintenance process and will continue to do that in the next quarter.

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.
• (from last BR) New page focused on wallet and asset aggregator integrations. (Issue #416)
• (from last BR) Fix github linter check that always fails on deploy when relative links are used.
• Continue working on improving the flow and organization of the docs.
• Discuss with MOM about whether Yearn needs a landing page with additional copy, images, etc to serve as a general landing page for new users.
• Update DAO/contributor docs to reflect current working practices of the DAO and governance process.
• Explore making RPC calls to get on-chain data to incorporate directly within the docs and to make the docs easier to maintain, especially with regard to contract addresses.
• Finalize process for automating V3 natspec version documentation and explore adapting it to other natspec docs as needed.

General

• Assist with community management as needed on discord and telegram. This helps me understand user needs and what is lacking.
• Tackle all other challenges that may come up throughout the work with enthusiasm and a "can-do" attitude.

Other Tasks (to be worked on as time permits)

YIP and Governance Cleanup

The governance process has been given little attention over the past months (years really) with very little effort put into maintaining existing processes outside of veYFI. The YIPs website and github repository are very stale and the forum only gets spotty attention when there are votes.

• Update, streamline, and clean up the YIPs repo and site. Guide submissions, help users with PRs and other github related stuff if needed.
• Discuss, flesh out and document the processes needed to submit a YIP.

State of Yearn Document

Work on a comprehensive internal document, with input from all yTeams, on the state of Yearn and its position in the broader market in order to better coordinate around decisions, priorities, and projects. This would be a living document that ideally could be kept updated and used as a touchstone in discussions around budget requests, product ideas, etc.

Deadline

2024-11-01 to 2025-01-31

People

• @rossgalloway (devdocs maintainer)
• @MarcoWorms (devdocs reviewer)

Money

• 8k USDC in yvUSDC, per month. 15% reduction from ~$9.5k (7.5k+ 0.4 YFI)

Split:

• 6.9k USDC per month, for @rossgalloway (maintainer)
• 1.1k USDC per month, for @MarcoWorms (reviewer)

Amount (Total)

8,000 * 3 = 24,000

Wallet address

0xA7b6f3d18db39F65C8056d0892Af76c07d15Fc5a

Reporting

Once