docs icon indicating copy to clipboard operation
docs copied to clipboard

Make use of Mermaid Diagrams

Open LukeTowers opened this issue 10 months ago • 3 comments

We should update our docs to make use of Mermaid diagrams: https://mermaid.js.org/config/usage.html. Would need to add support in the Nabu theme as well as update the doc content itself to include the diagram definitions where applicable.

LukeTowers avatar Jun 05 '25 15:06 LukeTowers

Where do we use diagrams in our Docs ?

mjauvin avatar Jun 05 '25 16:06 mjauvin

That's the point, we should use it more @mjauvin 😂 Especially in the database / relationships section.

LukeTowers avatar Jun 05 '25 16:06 LukeTowers

OMG I need this.

Should be easy to implement, I think we would just use a simple code block to surround the Markdown:

```mermaid
    ... graph code here
```

bennothommo avatar Jun 05 '25 23:06 bennothommo