DevDocs Budget Request

[rossgalloway]

Scope

I am opening this budget request to continue the Yearn documentation effort, which currently has no active contributors. The previous maintainer, @MarcoWorms, DMed me asking if I would help continue with the ever-evolving task of maintaining and updating Yearn's documentation infrastructure. I have previously contributed to the Yearn's docs (yearn/yearn-devdocs#391, yearn/yearn-devdocs#389). In the past, I worked at YAM, where I worked on many things, one of which was a documentation overhaul that was inspired by the Yearn devdocs.

My goal is 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 exporter and subgraph, and any other initiatives that need documentation. This budget request is for an introductory 3-month period where I will be getting up to speed with the docs and processes at Yearn with guidance from @MarcoWorms.

I have no previous BRs as this will be my first time working with Yearn. Marco will assist me in continuing to maintain the standard of documentation he provided. Previous BR by Marco (report included): #160

Plan

• Learn the ropes of the Yearn documentation and organizational structure.

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

• Continue to maintain the versioned vault docs and also work on automating the process for updating this information when new versions are released.

• Continue to maintain the algolia search script, which currently requires manual updating, and work on automating this process as well.

• Research upgrading docusaurus from 2.0 to the newest major version (3.2.1) plus all required dependencies to better support new examples and charts (i.e. Mermaid. See add mermaid support yearn-devdocs#400 and Upgrade Docusaurus to V3  yearn-devdocs#425). Then continue to keep the documentation repository and site updated with the latest dependencies and improvements.

• Bring a fresh set of eyes to the docs and propose -> spec out -> implement new ideas to improve clarity and usability including:

  • General cleanup and editing.
  • Look at upgrading docs content organization.
  • Add more interactive examples.
  • Add Additional diagramming and visual aides.

• Tackle all other challenges that may come up throughout the work with enthusiasm and a "can-do" attitude.

Deadline

2024-05-01 to 2024-07-31

People

• @rossgalloway (devdocs maintainer).

• @MarcoWorms (devdocs reviewer, training)

Money

• 2.5k DAI in DAI and 0.1 YFI, per month

Split

• 2.5k DAI and 0.1 YFI per month, for @rossgalloway

• 0 per month, for @MarcoWorms, per his request

Amount (Total)

7.5k DAI and 0.3 YFI for 3 months, total

Wallet address

0x88c868B1024ECAefDc648eb152e91C57DeA984d0

Reporting

Once

[MarcoWorms]

Confirming that I'm supporting Ross in this process!

[rossgalloway]

Yearn DevDocs May-July Progress Report

Link to Original BR request

Here is a list of everything that I have done in my first 3 months as devdocs maintainer.

Docs Content Updates

• Worked with @Wavey and @dudesahn to write and deploy updates to yLockers and yPRISMA Docs for YBS rollout.
  • Pull Requests: #427, #429
• Worked with @schagonia to write and deploy updates to yVaults V3 documentation:
  • Pull Request: #434
• Worked with @Wavey and @dudesagn to write and deploy updates to yCRV Docs for their YBS rollout.
  • Pull Requests: #435, #441
• Updates to yVault walkthroughs.
  • Pull Request: #437
• Updates to veYFI gauges.
  • Pull Request: #438
• Updates to Yearn Data Services.
  • Pull Request: #443
• Add Risks Overview Page. (not yet approved)
  • Pull Reqest: #444

Docs Functionality Updates

• Upgrade docusaurus (docs framework) to current version.
  • Pull Request: #426
• Add Mermaid chart functionality (required upgrade above).
  • Pull Request: #436

Docs Organization/Structure Updates

I have been working on an extensive update to the structure of the docs that I am calling the "DevDocs Revamp". It is an effort to streamline and simplify the structure of the docs site so that is easy to use for Users, Developers, and DAO members/contributors.

• Original Document laying out goals: https://hackmd.io/@rossgalloway/rJgQN_5mR
• Slideshow showing progress and rationale for changes: https://docs.google.com/presentation/d/1rruTTqJMmg49LxhyvGHb80QgE4t_nXD_ZINr8yOhlLY/edit?usp=sharing

I have a preview version of the updated site available for anyone to visit here: https://yearn-docs-omvyfkq9l.yearn.farm/

Major Changes include:

• Simplification of navigation (User/Developer/Contributor).
• Navbar and footer cleanup
• New Landing Page.
• New sidebar nav structure.
• New Versioning system to account for multiple products with versioning.

Still lots of work needed, but I believe it is a good foundation from which to continue improving the docs. Now the content needs to be brought up to match the layout.

I am actively soliciting feedback on this design/structure so please leave any comments below or reach out to me on TG / Discord.