The yearn devdocs website is built using Docusaurus, a modern static website generator.
yarn install
yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
yarn build
This command generates static content into the build
directory and can be served using any static content hosting service.
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push it to the gh-pages
branch.
We have 2 types of documentation: versioned documentation and non-versioned documentation:
For detailed information on the contributing workflow, please see the Contributing Documentation.
In the docs
folder:
In versioned_docs
you will find several versions of the vault documentation that corresponds to a tagged release. In vaults
folder you can find the latest version that corresponds to the changes on yearn-vault master is the documentation for the next/unreleased version.
Dependencies
~/.vvm/vyper-X.X.X
in the end of the first command below.yearn-vaults
folder has the same compiler version on their first line. If not, bump the file with the lowest version to the current version the other uses.^
) you may have to add it so the solc
compiler will run. Also, make sure solc
version is up-to-date.solc
try to install it locally on the project with npmGenerate:
To generate API documentation and coin a new release, do the following.
npx vydoc -i ../yearn-vaults/contracts/ -o ./vaults/smart-contracts -t ./templates/contract.ejs -c ~/.vvm/vyper-0.3.3
npx solidity-docgen@0.5.17 --solc-module solc --templates=templates --helpers=helpers/solidityHelpers.js -i ../yearn-vaults/contracts/ -o ./vaults/smart-contracts
npm run docusaurus docs:version 0.4.5
After that copy yearn-lens/.
, yearn-sdk/.
and yearn-api.md
from the previous versioned documentation's folder into the new one.