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

[rossgalloway]

End of Period Report

DevDocs had a busy quarter that I would like to share with you all.

Listed Goals

• 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.

  • I now have a much better grasp of how the V3 contracts and registries work after updating the Contract address page, implementing automated address checking, and working on the wallet and aggregator integration page. See below for more on these features.
  • Same goes for yPools, although the update for the docs is not quite complete. See below for more.
  • I am working on unleashing the power of Kong to highlight Yearn Vaults
  • the DAO section of the docs still need more love, but given the changes to governance to move on-chain, this will happen naturally in the near future as those features get rolled out.

• Continue to maintain the current yearn-devdocs while adding and improving the documentation for new products (vaults v3, yETH, yLockers, yPools, etc.)

  • update yETH addresses yearn-devdocs#489
  • Chore: add new veyfi gauges yearn-devdocs#490
  • add guardian information yearn-devdocs#494
  • chore: update multisig signers yearn-devdocs#501

• Work with ySupport to keep User guides up to date and relevant

  • New user FAQ here for commonly asked questions: https://docs.yearn.fi/getting-started/guides/user-faq
  • Feat: Add new FAQ to guides section yearn-devdocs#482
  • The above is now already outdated due to UI changes 😒. Will update next BR.

• 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.

  • Fix: admonition and landing page bug yearn-devdocs#477
  • fix: css tweaks for mobile search and landing screen yearn-devdocs#486
  • Fix: AddressCheck action yearn-devdocs#495 This is still not working 😒. Issue for it here: Get Daily Address Checks working yearn-devdocs#502
  • Chore: clean up actions yearn-devdocs#497
  • fix: remove lock calculator when not needed and improve button behavior yearn-devdocs#500
  • Updated to the newest Docusaurus version. chore: update docusaurus version yearn-devdocs#504

• (from last BR) New page focused on wallet and asset aggregator integrations. (Issue #416)

  • Finally got this done. Banteg Happy.
  • https://docs.yearn.fi/developers/wallet-integration
  • Feat: wallet integration guide yearn-devdocs#499

• (from last BR) Fix github linter check that always fails on deploy when relative links are used.

  • This is a bitch. I spent some time on it and got nowhere. For now I will continue to check links manually and hope that I can sort out a better solution soon.

• Continue working on improving the flow and organization of the docs.

  • I have lots of thoughts on this and will post some mockups of ideas in the next comment. I believe the docs should be as useful as possible, and this if why I have been working on widgets like the veYFI calculator and charts. I want to add more functionality to the docs, including implementing the charts directly, allowing smart contract interactions, and better smart contract documentation.

• 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.

  • see later sections of this post.

• Update DAO/contributor docs to reflect current working practices of the DAO and governance process.

  • Didn't get to this, but this is all a bit in flux given the slow transition to on-chain governance.

• 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.

  • this is done! Calls to read functions on contracts are possible from within the docs and markdown files.
  • See this section of the readme for more info: https://github.com/yearn/yearn-devdocs/blob/master/README.md#blockchain-rpc-calls
  • Contract Address checking is active for V3 contracts and veYFI contracts.
    • PR is here for V3: feat: add RPC calls and checks yearn-devdocs#485
    • PR is here for veYFI: Feat: add veYFI contract checks yearn-devdocs#496
  • This functionality was used to build the veYFI boost calculator and is being used in the updated yPools documentation.

• Finalize process for automating V3 natspec version documentation and explore adapting it to other natspec docs as needed.

  • Completed here: Feat: add natspec script yearn-devdocs#478
  • used to easily update to the newest v3 version
  • read more about using it in the readme here: https://github.com/yearn/yearn-devdocs?tab=readme-ov-file#generating-v3-smart-contract-documentation

Other Tasks

I did not end up doing any work on the YIPs or a State of Yearn document. Given on-chain governance is still a ways away, the YIPS work didn't seem pressing. And the State of Yearn is that it seems to be always in flux, although I continue thinking about those issues.

But I did work on a few other things:

Yearn Dashboard

The Yearn Dashboard is a significant improvement to the yearn-charts site I worked on last quarter. It gives historical APY data for all v2 and v3 yearn vaults, sources from Kong, displaying them in a easy and professional way.

Sonne Creditor outreach

I worked on a new proposal for Sonne Creditors to invest in Make.Fun, the new platform from their team. This is still a bit in the air since they are waiting on an AERO gauge that may not come. A proposal was shared internally in cantina.

SuperDocs

I have also been thinking about the next steps for Yearn and its front-end needs as MOM appears to be stepping back and moving their commitment to maintenance mode. One idea that I have had is to use the docs as an alternate front-end for users. These features would serve as a backup if there are issues with the main dApp and could be used as a staging ground for different UX ideas.

The gist is to separate the docs into the documentation section and a "tools" section (names still WIP). This tools section could expand incrementally, starting with the existing widgets like the veYFI Boost calculator. It could then be updated to include a wallet connector and functionality to withdraw and deposit. I would also like to combine the smart contract documentation with a smart contract calls section, similar to an etherscan like interface.

Here are some mockups I put together: