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

fix: mermaid diagram #191

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

kodaline
Copy link
Collaborator

Fix: reactivating mermaid plugin so that mermaid diagrams are displayed correctly on docs

@nicola-corbellini @sambarza tagging both of you

I have noticed that the issue #190 is due to the commenting of mermaid plugin for mkdocs, I re-added it and tested it locally, the diagram is displayed correctly.
I have no idea if the mermaid plugin was commented for some important reasons or it was just an oversight that's why I want to check with you before merging.

@nicola-corbellini
Copy link
Member

Honestly, I don't remember why it had been commented out.
It may be because all the mermaid diagrams had been removed and we forgot this one. I think there should be no problem introducing it back, unless something that I'm not aware of changed recently

@kodaline
Copy link
Collaborator Author

Honestly, I don't remember why it had been commented out. It may be because all the mermaid diagrams had been removed and we forgot this one.

Oh ok so do we prefer to remove the diagram?

@nicola-corbellini
Copy link
Member

Don't know which are the plans, lately. IMHO the diagrams may be helpful, I would even restore the old ones 🤣

@pieroit
Copy link
Member

pieroit commented Sep 27, 2024

@kodaline @nicola-corbellini I also like the diagrams and pictures, the more the better

@kodaline
Copy link
Collaborator Author

@kodaline @nicola-corbellini I also like the diagrams and pictures, the more the better

so do we want to restore the other diagrams? In case I would use git history to find what is missing

@sambarza
Copy link
Collaborator

sambarza commented Oct 3, 2024

I propose to reactivate the mermaid plugin in the meantime ;-)

@kodaline
Copy link
Collaborator Author

kodaline commented Oct 5, 2024

I propose to reactivate the mermaid plugin in the meantime ;-)

I have checked old versions of the docs but the only flowchart seems to be the one in the issue #190

@nicola-corbellini
Copy link
Member

Let me check

@nicola-corbellini
Copy link
Member

They are available in this version

@kodaline
Copy link
Collaborator Author

kodaline commented Oct 5, 2024

They are available in this version

LOL I did not went so much back in time, I expected they were removed around the period the mermaid plugin was deactivated ahah ok I will re-add them, thank you @nicola-corbellini <3

@kodaline kodaline marked this pull request as draft October 7, 2024 21:28
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

Successfully merging this pull request may close these issues.

4 participants