Add graph images to our docs?

carnival-data / carnival

JVM property graph data unification framework

https://carnival-data.github.io/carnival/

GNU General Public License v3.0

7 stars 2 forks source link

Add graph images to our docs? #81

Closed augustearth closed 2 years ago

augustearth commented 2 years ago

Particularly on index.md, some graph images may help explain/advertise Carnival features.

augustearth commented 2 years ago

Mermaid diagrams can now be added to GitHub docs:

https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams
https://mermaid-js.github.io/mermaid/#/n00b-syntaxReference

augustearth commented 2 years ago

Mermaid works for markdown files displayed on GitHub.com, but not on Github pages at least not yet. Will add mermaid graphs where it seems appropriate.