DevDocs Budget Request

[rossgalloway]

Scope

This budget request is to continue the Yearn documentation effort. I have worked as the devdocs maintainer for the last 3 months (BR here) and would like to continue with my efforts to improve and expand upon Yearn's documentation. A report of the work I have done over the last 3 months can be seen here.

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.

The devdocs are currently in a state where they are functional and have lots of information on the multiple parts of Yearn, but this information is fragmented and sometimes outdated or inaccurate. The organizational structure is haphazard and reflects the peicemeal way that information has been added over the years. By consolidating, updating, and improving on the docs, there is an opportunity to fill a missing piece of Yearn's information ecosystem: The passive sales and marketing domain that is not captured with the dApp and out of scope of the social channels.

As @MarcoWorms is moving on, he will be transferring the github repo permissions to me to continue the work. We have discussed keeping him on as a reviewer. I would also like to distribute review responsibilities to stakeholders in different teams as needed for their documentation (this usually happens anyway).

My requested compensation is bumping up from the initial "trial period" rate that I requested in my first BR.

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
• Confirm move to new versioning system for the website and assure stakeholders are aware of how this has changed. Write docs to document new process.
• Finalize updating the algolia script to automatically re-index upon master branch pushes. Troubleshoot issues as they come up/ (PR #439)
• continue to maintain and improve the backend infrastructure for the docs. Keep dependencies up to date and add new features as needed.
• New page focused on wallet and asset aggregator integrations. (Issue #416)
• Fix github linter check that always fails on deploy when relative links are used.

Improvement Tasks

• Continue working on the "DevDocs Revamp" organizational changes. See this presentation
  • Solicit comments on current re-design
  • Implement changes from comments on re-design to dev branch.
  • Implement approved changes to master branch cleanly
  • Add quality of life improvements. Better links, graphics, marketing copy, etc.
  • Flesh out yearn landing page with additional copy, images, etc to serve as a general landing page for new users.
  • Work on splitting out important information about products in user docs (layman audience) and dev docs (technical audience).
• Update DAO/contributor docs to reflect current working practices of the DAO and governance process. Futureproof for new changes in veYFI and on-chain voting. veYFI docs page needs lots of work to be understood by the average user.

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.

Deadline

2024-10-31

People

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

Money

• 7.3k DAI in yvDAI and 0.4 YFI, per month

Split

• 6.3k DAI and 0.3 YFI per month, for @rossgalloway (maintainer)
• 1k DAI and 0.1 YFI per month, for @MarcoWorms (reviewer)

Amount (Total)

21.9K DAI and 1.2 YFI

Wallet address

TBD - need to create multi-sig?

Reporting

Once

[rossgalloway]

End of Period Report

Implementation of the "Devdocs Revamp" reorganization has been completed in that all the big changes are complete. Styling is updated, docs are split into user, dev, and dao sections, sidebars are more intuitive. Natspec docs are re-organized and there is a new workflow to generate docs more easily.

As a reference, this is what the docs looked like before: https://yearn-docs-ba94fydb3.yearn.farm/
This is what they look like now: https://docs.yearn.fi

Content Updates

• Updated Yearn Data Services section
  • Feat: update yearn data services yearn-devdocs#443
  • https://docs.yearn.fi/developers/data-services/yearn-data
• Added risks overview page
  • Feat: add risks overview page yearn-devdocs#444
  • https://docs.yearn.fi/developers/security/risks/
• Restructured Smart Contract Versioning
  • Feat: refactor versioning yearn-devdocs#448
  • https://docs.yearn.fi/developers/smart-contracts/
• Re-organized Token Addresses Section
  • Feat: update dev section sidebars yearn-devdocs#452
  • https://docs.yearn.fi/developers/addresses/
• Created new yVault info pages for user docs with diagrams for both V2 and V3 yVaults and New FAQ page.
  • https://docs.yearn.fi/getting-started/products/yvaults/v3
  • https://docs.yearn.fi/getting-started/products/yvaults/v2
  • https://docs.yearn.fi/getting-started/products/yvaults/yvaults-faq
• Updated and Moved veYFI section. Add new summary page.
  • Feat: move and improve veYFI section yearn-devdocs#459
  • https://docs.yearn.fi/contributing/governance/veYFI-intro
• Further updates to veYFI page (Open PR).
  • update veYFI docs yearn-devdocs#472
  • Update to detailed specification page based on all info.
  • https://yearn-docs-ozh6j87uf.yearn.farm/contributing/governance/veYFI-comp-summary
• Updates to yETH/yPools documentation (Open PR)
  • first pass at yPools updates yearn-devdocs#473
  • Restructure between user and dev docs
  • New page on adding assets to yETH
• Update V3 natspec docs to version 3.0.3 (Open PR)
  • Add new v3.0.3 contract natspec and update v3 contract address page yearn-devdocs#475
• Update Multi-sig Signers (Open PR)
  • Chore: update Multisig signers yearn-devdocs#476

Implement Styling and Design Changes

• Update page width and sidebar styling
  • feat: update page width and sidebar styling yearn-devdocs#449
• New Headers and Footers
  • feat: update header and remove footer yearn-devdocs#453
• New "fancy" Link Button styling
  • Feat: Create PrettyLink button component yearn-devdocs#457
• New Yearn branded callout
  • https://docs.yearn.fi/getting-started/products/yvaults/overview
• Landing Page
  • Feat: update landing page yearn-devdocs#456
  • https://docs.yearn.fi/
• User Docs organization and new Principles page
  • Feat: update user docs structure and add Yearn Principles yearn-devdocs#458
  • https://docs.yearn.fi/getting-started/intro
  • https://docs.yearn.fi/getting-started/yearn-principles
• Updated fonts to match yearn.fi
  • feat: update fonts to match yearn.fi  yearn-devdocs#470

Quality of Life Changes

• add branch name on dev builds
  • Feat: add branch display to dev builds yearn-devdocs#468
• Created new workflow for natspec documentation for V3 (Open PR)
  • Update v3 natspec to 3.0.3 and add natspec documentation pipeline yearn-devdocs#474
  • update repo to use submodules
  • updated vydoc template
  • New Script to generate docs files
  • The PR linked above is closed, but the work will be ported to a new PR when #475 goes through.

Misc other Work

• Research on new Kong public API to create future docs.
• Built Yearn-Charts interface to learn about and use the new Kong API.
  • https://yearn-charts.vercel.app
  • https://github.com/rossgalloway/yearn-charts
  • presents APY data for all Yearn vaults on all chains and displays it for 7, 30, 180, and "max" day intervals.
• Assistance in discord for user problems.
• I helped the Sonne Depositors group with navigating the governance process.

There are some elements I didn't get to:

• A new page for wallet integrations (pushed to next BR)
• Update linter in build step (pushed to next BR)
• Update landing page further with more info and to serve as general landing page. (not sure if this is actually valuable and needed.)

Other work still pending:

• top 2 items in above section
• Improved DAO Docs
• Improved Guides
• Kong Public API documentation
• Continued Subgraph docs improvement
• Port v3 natspec documentation flow to v2.
• Coordinate with SAM to update risks and security sections.