kernelci / kernelci-project

KernelCI Linux Foundation project documentation
9 stars 25 forks source link

Use markdown mermaid diagrams in documentation #347

Open nuclearcat opened 1 month ago

nuclearcat commented 1 month ago

Mermaid diagrams supported in github markdown parsing, and probably hugo can support it too, so we can have nice diagrams like this:

mermaid-diagram-2024-05-02-165628 This link clickable and points to live editor:

JenySadadia commented 1 month ago

Yes, we already have a bunch of mermaid digrams for API and Pipeline docs. See https://kernelci.org/docs/api/pipeline-details/