Documentation

The application uses hybrid documentation to stay up-to-date. Each package README and internal structure are auto-generated.

The auto-generated documentation is generated from js-doc like comments:

• @extPoint - allows marking a function as great for place for extension

• @extExample - allows providing a ready (copy-paste) extension example

• @example - allows specifying an example of function usage

• @namespace - namespace of the function according to the plugin mechanism

If your module is located in packages folder of original mono-repository the documentation can be automatically extracted with yarn docs command.