Official documentation
For Contributors
Every new feature or change already existing feature should be described into the documentation. To change the documentation you need to execute next steps:
- Go to
/docs/docs
folder - Change the documentation using
.md
files - If you want to change sidebar or navbar you can do it in
/docs/docs/.vuepress/config.js
- Run it on localhost from, folder
/docs
usingyarn docs:dev
- Push your changes
If you create a new service and write documentation for it please follow next template:
- service definition - what this service can be used for
- register service - how the service should be registered
- access service - how the service can be accessed
- technical documentation - details about the service, examples and different use cases