flame icon indicating copy to clipboard operation
flame copied to clipboard

docs: component tree diagram typo

Open alestiago opened this issue 3 years ago • 7 comments

What could be improved

The following diagram (component_tree) has a typo. More specifically the IsoMetricTileMapComponent is spelled as IsoMetricTileMapCompoenent.

image

Why should this be improved

To make the docs accurate.

Any risks?

No.

alestiago avatar Mar 29 '22 17:03 alestiago

Did we open an issue about making the diagrams "in code" so that they are easier to change @st-pasha?

spydon avatar Mar 29 '22 19:03 spydon

I don't think we ever made an issue for that

st-pasha avatar Mar 29 '22 19:03 st-pasha

I don't think we ever made an issue for that

I'll open one.

You made a theme to do it if I remember correctly?

spydon avatar Mar 29 '22 19:03 spydon

I've been playing around with dcdg package and it seems like it might work. I was able to generate this using output from that package and the command line tool from graphviz

dot1

The output is not very presentable, but I think it enough for a POC. I still had to manually tweak the output from that package to get to this stage. I've also opened some issues on their repo to make easier for us to use and automate it. If anyone else is working on this or have any other idea in mind, let me know. Here is a list of formats which dcdg supports:

For use dots is perfect as it just deals with the class names unlike others. Other formats are more geared towards UML and display the class members as well.

ufrshubham avatar Sep 17 '22 17:09 ufrshubham

@st-pasha made something that looked pretty good a long time ago as a poc, but I don't remember which library he used.

Edit: I think it was mermaid

spydon avatar Sep 17 '22 19:09 spydon

Yeah, style-wise, mermaid's output is the closest to the image that we have right now in docs.

ufrshubham avatar Sep 17 '22 20:09 ufrshubham

Yes, we can already generate mermaid diagram in the docs, just add a snippet like

```{mermaid}
%%{init: { 'theme': 'dark' } }%%
sequenceDiagram
  participant Alice
  participant Bob
  Alice->John: Hello John, how are you?
  loop Healthcheck
      John->John: Fight against hypochondria
  end
  Note right of John: Rational thoughts <br/>prevail...
  John-->Alice: Great!
  John->Bob: How about you?
  Bob-->John: Jolly good!
```

We may want to figure out a way to customize the default theme so that it has more flame-like colors. But other than that, the diagram can be implemented with the current setup.

st-pasha avatar Sep 17 '22 21:09 st-pasha