Facilitate diagrams modifications and creations for contributors

[rollniak]

Hello,

I want to fix a typo in this

The problem is I don't know what tools you are using to draw schematics nor I'm having access to an easily editable file to edit them.

Suggestions

We could create schematics by using something like:

• Mermaid which can be integrated with MKDocs Material - Diagrams or similar tools if they exists.
• one tools listed on the Asciidoctor diagram

If it's not an option we can use digrams.net wich:

• Is not platform specific
• It can export diagrams in PNG, SVG and others formats.
• the .drawio format used to edit the diagrams is just an XML file

We have some advantage by doing that:

• Tracking the modifications of schemas is facilitated since diagrams will become simple text.
• Tools that create and edit schema will become the same for every contributors.

What do you thin about it ? :)

[mekanix]

I just added support for mermaid. Really good find! Is there any other improvement that we can do?

[rollniak]

We can update the README with more informations and link about how people can contribute to the documentation. :smiley:

e.g: add a link to Mermaid documentation for new comers that doesn't know how to use it.