The mermaid diagram is not shown on Description (the content from Discourse)

[taurus-forever]

Hi,

Please check mysql-router on charmhub.io: https://charmhub.io/mysql-router?channel=dpe/edge
and on GitHub: https://github.com/canonical/mysql-router-operator/blob/main/README.md

As you can see the basic mermaid diagram is not processed on charmhub.io and shown as a plain text: flowchart TD...

It looks like https://warthogs.atlassian.net/browse/WD-665 was a subtask for develop mermaid support.
Is it a not-yet implemented feature or a bug? Thank you!

P.S. we would like to publish more complex diagrams, but without charmhub.io support mermaid is a risky choice.

[taurus-forever]

Hint: if you wish to publish mermaid on charmhub: publish screenshots with links to GitHub, e.g. https://charmhub.io/postgresql-k8s/docs/e-charm?channel=14/stable

[Lukewh]

I believe this is no longer relevant since we made this change. Closing, but please reopen if you think it's still relevant :).

[taurus-forever]

Dear @Lukewh , it is still relevant for Data Platform team.

Please see the following examples:
https://charmhub.io/mysql-k8s/docs/e-flowcharts
https://charmhub.io/postgresql-k8s/docs/e-charm
https://charmhub.io/postgresql-k8s/docs/e-peers
https://charmhub.io/postgresql-k8s/docs/e-backups

As you can see we are actively using mermaid diagrams to describe the internal logic of our charms.
Unfortunately it produces issues for us on Discourse->GitHub sync. We have to manually restore mermaid blocks in bot PRs, example: canonical/mysql-k8s-operator@4a5aeae

We really looking forward to add mermaid support for charmhub.io (as Discourse supports mermaid nowadays).
Please reopen this issue. Thank you!

[Lukewh]

Aha, I see. I'll reopen and rename this issue to relate to discourse rendering, not GitHub README rendering 👍

[Lukewh]

@taurus-forever this is now live, and you can see the resulting diagram on https://charmhub.io/mysql-k8s/docs/e-flowcharts :).

[taurus-forever]

... this is now live ...

You are my HERO! Thank YOU!!!
P.S. applied the change to https://charmhub.io/mysql-k8s/docs/e-flowcharts (all other pages will follow).
P.P.S. It implies our life A LOT. THANK YOU!!!

[taurus-forever]

@Lukewh there is a small bug (if page has 2+ diagrams): https://charmhub.io/postgresql-k8s/docs/e-charm
Should I report it as a separate issue?

[Lukewh]

@Lukewh there is a small bug (if page has 2+ diagrams): charmhub.io/postgresql-k8s/docs/e-charm Should I report it as a separate issue?

Please do! I'll take a look anyway, but good to track it separately :)

[Lukewh]

@taurus-forever never mind, already merged: #1586 :)

[taurus-forever]

@taurus-forever never mind, already merged: #1586 :)

The fix confirmed, thank you one more time!