Adding architectural descriptions to the documentation #472
WolfgangFahl
started this conversation in
Ideas
Replies: 2 comments
-
Link: http://diagrams.bitplan.com/render/png/0xf2d17f13.png |
Beta Was this translation helpful? Give feedback.
0 replies
-
http://diagrams.bitplan.com/render/png/0xd6358687.png Source code: http://diagrams.bitplan.com/render/txt/0xd6358687.txt |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
The software architecture of justpy needs quite some explanation to make the code base maintainable.
Currently the documentation is focussed on a user view and there are excellent tutorials how to use justpy in different usecase and
how to configure it for the purposes.
For the maintainers and to enhance the software it would be helpful to get an overview of the software and do a classical hierachical decomposition of what justpy consists of
System context
The top level view of the hierachical decomposition should show the core elements of justpy.
Here is a draft plantuml - diagram for this source code
Vue
Diagrams
According to https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams it is possible to use diagrams in github markup:
https://github.com/mermaid-js/mermaid/blob/develop/docs/classDiagram.md shows the support of class Diagrams.
Beta Was this translation helpful? Give feedback.
All reactions