Bloc: Improving user experience in documentation

Created on 22 Sep 2020 · 4Comments · Source: felangel/bloc

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

To begginers, it's difficult to visually represent the concepts managed in the demos or, even, in the core concepts section.
We have difficulties to know what the structure of each demo (tutorial) is.

Describe the solution you'd like
A clear and concise description of what you want to happen.

To show a diagram (class diagram, sequence diagram and so forth or visually more attractive) to represent better the architecture of each contained demo in the tutorial.
To show a tree structure of the project above each code to indicate where this code lives.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Show a diagram with boxes where each box represents a class/module which is contained into the application.
Show a tree diagram above each code to indicate the folder of that file.
Each file should have three tabs: architecture (it shows how this module interacts with others); tree (it shows which folder contains this file); code (it shows the code itself along with your comments).

Additional context
Add any other context or screenshots about the feature request here.

When an user clicks over on each box inside the diagram, it should show the tree/code of that file/box.
When an user clicks over on each tree diagram, this should unfold the minimalist version of this tree showing the location of this file under the tree.

Best regards.

documentation

Source