Problem
The current documentation doesn't reflect all the iteration between the modules or it has some diagrams spreaded accors some diferent docs. This makes a little bit hard to understand the inter module communications, inside the bigger picture which is the Magma architecture itself.
Solution
A possible aproach is - as Jack the ripper, piece by piece - breaking from the higher components to the smaller modules and creating links in the documentation of each component (which has a lot of information already).
This way we can create a depper visualization not alone for each module but also with the information exchange between them.
Another bonus of that is to identify duplicated components and mark them for a possible refator in the future, or even find "undocumented features".
Non-goals
Anything specifically excluded from the concept
Problem
The current documentation doesn't reflect all the iteration between the modules or it has some diagrams spreaded accors some diferent docs. This makes a little bit hard to understand the inter module communications, inside the bigger picture which is the Magma architecture itself.
Solution
A possible aproach is - as Jack the ripper, piece by piece - breaking from the higher components to the smaller modules and creating links in the documentation of each component (which has a lot of information already).
This way we can create a depper visualization not alone for each module but also with the information exchange between them.
Another bonus of that is to identify duplicated components and mark them for a possible refator in the future, or even find "undocumented features".
Non-goals
Anything specifically excluded from the concept