Skip to content

vsc-eco/docs

Repository files navigation

VSC Documentation

Local Development

$ 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.

Deployment

execute ./publish.sh or just push to main (github actions workflow will take care of the rest)

The repository needs to have its workflow permissions set to read and write, instead of the default vaule. Change that under the repositories settings -> Workflow permissions

TODO

Reminders

  • when contract deployment supports lite accounts, add to the documentation
  • move api documentation to the code a la js/ typedoc and just link to it, only manually add documentation to the doc here that describes how those components might be used (examples) or in conjunction