Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Workflow for vydoc for V3 docs #430

Open
rossgalloway opened this issue May 16, 2024 · 1 comment
Open

Add Workflow for vydoc for V3 docs #430

rossgalloway opened this issue May 16, 2024 · 1 comment

Comments

@rossgalloway
Copy link
Collaborator

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: #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
Copy link
Collaborator Author

This is addressed in #474

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant