mermaid
mermaid copied to clipboard
mermaid-js
Would a 'stack diagram' be of interest?
I often have a need to create stack diagrams, example below.
Would there be any interest in accepting a pull request that creates these kinds of diagrams? I think it wouldn't be too bad to capture the technique I use to create them and implement it in code, but wanted to confirm interest before starting on the effort.
I'll have some time off around the holidays and will dig in then, so if someone has the work planned before then please reach out ([email protected]), or give me until end of year :-)
@eliaskanelis wow, august 2022, time flies... I'd like to take a crack at this during the next break I have, likely during a holiday but I'd also gladly use it if someone else puts it together earlier :-)
My expertise is C and C++ as I am an embedded engineer. I know some JavaScript, but at a hobby level. I have some spare time to help, but I am limited to my lack of expertise on web development. Could I help somehow?
The first step would be to decide on a syntax that we can use. @knsv is this similar to the block diagram that you are working on?
I have done some brainstorming with a few people from work, and we came to this draft:
stack:
style: {fill: black,4pt,...}
layer:
block:
style: {fill: black,4pt,...} # Inherited if not assigned from parent
[App1]->[RTOS]
block:
[App2]->[RTOS]
block:
["Bare metal app"]->[RTOS, Microcontroller]
layer:
block:
[RTOS]->[HAL]
layer:
block:
[HAL]->[SPI, I2C, UART, Microcontroller]
layer:
block:
[SPI]->[Microcontroller]
block:
[I2C]->[Microcontroller]
block:
[UART]->[Microcontroller]
layer:
block:
[Microcontroller]
The mermaid syntax draft tries to describe the following.
I hope this helps. I might not know JS to aid in coding, but I can help in other areas.
As a first draft, I see layers and blocks. After that, we could introduce stackable stacks... Or it might become too complicated? I have no experience with the mermaid code.
@cmorganBE the shared sample looks very similar to the packet-diagram that I've been building here
@eliaskanelis, your example looks interesting. Are the vertical stacks taken from some reference images? Can you share some sources to get some more examples?
@sidharthv96 yes sure! It is called layered architecture. I found some more pictures from the web.
In the automotive domain, there is something called AutoSar.
It would be cool if mermaid could be used to draw these diagrams.
