docs: add flowchart #24
Conversation
Signed-off-by: knqyf263 <[email protected]>
Signed-off-by: knqyf263 <[email protected]>
README.md
Outdated
|
|
||
| classDef dev fill:#e6f3ff,stroke:#333,stroke-width:1px; | ||
| classDef vexHub fill:#fff0f5,stroke:#333,stroke-width:1px; | ||
| classDef crawler fill:#e6ffe6,stroke:#333,stroke-width:1px; |
There was a problem hiding this comment.
I suggest using a different background color.
header not visible in dark theme:
same for sourceRepo
There was a problem hiding this comment.
I suggest using a different background color. header not visible in dark theme:
I updated the color, but then, it was no longer light-mode friendlly. It looks like others are also facing the same problem.
- https://youtrack.jetbrains.com/issue/IJPL-97749/Some-Mermaid.js-graphs-are-barely-readable-in-dark-themes
- Mermaid Diagrams in Dark Mode alshedivat/al-folio#1609
As far as I know, GitHub doesn't support dark mode, and most people see this diagram on GitHub. I believe it's fine.
There was a problem hiding this comment.
As far as I know, GitHub doesn't support dark mode
I use dark theme on my PC and GH uses system theme (you can see all themes here - https://github.com/settings/appearance).
That is why i saw problem with background.
But now it looks better:
There was a problem hiding this comment.
Ah, I tried dark mode on GitHub, but didn't like it, and probably changed it back😄
README.md
Outdated
| subgraph Src [Source Repository] | ||
| Dir[.vex/ directory] -->|Store| Doc[VEX documents] | ||
| end |
There was a problem hiding this comment.
not sure a subgraph helps here, maybe simplify with just a text that demonstrates the .vex dir path?
anyway, shouldn't it be /.vex instead of .vex/
Co-authored-by: Itay Shakury <[email protected]>
Co-authored-by: Itay Shakury <[email protected]>
Co-authored-by: Itay Shakury <[email protected]>
Co-authored-by: Itay Shakury <[email protected]>
Co-authored-by: Itay Shakury <[email protected]>
Signed-off-by: knqyf263 <[email protected]>
|
The direction of the arrow changes the layout significantly. As far as I know, it is difficult to get the layout to do what we want in Mermaid.js.
I know that some parts are not technically correct, but I will go with this diagram for now. |
No description provided.