bobcamera / bobcamera

GNU Affero General Public License v3.0
16 stars 2 forks source link

System Architecture Diagram/Notes #183

Open danlohman opened 2 months ago

danlohman commented 2 months ago

It would be great if we could could describe the architecture and flow of the system at a granular level. We could then create a visual map of the packages, nodes, etc to understand the system more intuitively. The readme files in the package folders are a great start. It would be helpful to be able to understand the order of operations of how a frame progresses through the image pipeline (and the associated nodes). Having a reference to connect notes in the readme files directly to file names and functions would be very helpful in learning the codebase. It would be particularly helpful if this was detailed especially from configuration, to launch and through the beginning of the image processing pipeline. Its hard to get a sense of a node based system from the code alone and for me, not knowing C++ well, makes it more challenging to skim the code to get that understanding without a guide. I suspect this would be helpful to new developers learning the codebase in the future as well.