yearn / yearn-devdocs

yearn documentation
https://docs.yearn.fi
MIT License
84 stars 76 forks source link

Add Workflow for vydoc for V3 docs #430

Open rossgalloway opened 6 months ago

rossgalloway commented 6 months ago

Need documentation for the V3 Vault contracts similar to the documentation for V2 Vault Contracts. We need a workflow to easily and effectively create documentation for the new contracts and a flow to add it to versioning.

Consider the potential changes being made to simplify versioning as seen in this pull request: https://github.com/yearn/yearn-devdocs/pull/428. But the flow to create documentation from the smart contracts is mostly unrelated to how the site structure is set up.

Should be similar to this: https://github.com/yearn/yearn-devdocs?tab=readme-ov-file#generating-versioned-documentation, but with the new v3 repo.

rossgalloway commented 1 month ago

This is addressed in #474