New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add developer documentation to the guide #126

Closed

6 tasks

mspanc opened this issue Dec 5, 2018 · 1 comment

Labels

docs enhancement

Contributor

mspanc commented Dec 5, 2018

We need to have a developer documentation that explain:

what are all these controllers, dispatchers and loggers,
what is the process architecture being used for pipelines,
what kind of messages flow between different parts of the system,
what is the meaning of fields in the the internal structures,
how pulling works,
how integration with native code is designed.

mspanc added enhancement docs labels

mspanc changed the title ~~Add internal data flow documentation to the guide~~ Add developer documentation to the guide

Member

mat-hek commented Dec 5, 2018

Some of these things are already documented, but as comments in the code, e.g. element's internal architecture is briefly described here.

mat-hek closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment