25 lines (18 loc) · 794 Bytes

Updating Documentation

When you make changes in proto/config.proto then docs/src/configuration/reference.md must be regenerated. Install protoc and protoc-gen-doc:

curl -L -o protoc-gen-doc.tar.gz https://github.com/pseudomuto/protoc-gen-doc/releases/download/v1.5.1/protoc-gen-doc_1.5.1_linux_amd64.tar.gz
tar -xzf protoc-gen-doc.tar.gz
chmod +x protoc-gen-doc
sudo mv protoc-gen-doc /usr/local/bin/

If you make changes in any event provided you must generate JSON schema for all events `docs/src/events/reference.md'.

All reference.md files can be updated via:

cargo xtask docs-gen

Event examples are updated manually. You can print event examples after tests execution and put them into docs:

cargo xtask test --release --example-events