Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Facilitate diagrams modifications and creations for contributors #24

Open
rollniak opened this issue Mar 2, 2022 · 2 comments
Open

Comments

@rollniak
Copy link

rollniak commented Mar 2, 2022

Hello,

I want to fix a typo in this schema

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:

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
Copy link
Member

mekanix commented Mar 3, 2022

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

@rollniak
Copy link
Author

rollniak commented Mar 3, 2022

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants