kernelci / kernelci/kcidb

Consider redrawing architecture diagram using Mermaid

Open
#240 2 comments 0 reactions 1 assignee Claimed by @octonawish-akcodes View on GitHub
good second issue
Dominant language
Python
Stars
26
Forks
40
PR merge metrics
No merged PRs in 30d

Description

@gctucker [said earlier](https://github.com/kernelci/kcidb/pull/238#discussion_r753338087):
> ASCII art is cool, but for this static website there's also Mermaid which is easier on the eyes.
>
> See this example:
> https://github.com/kernelci/kernelci-project/blame/main/kernelci.org/content/en/docs/architecture.md#L53
> and how it's rendered:
> https://kernelci.org/docs/architecture/

Consider using that to make the architecture diagram nicer in `doc/administrator_guide.md`. One drawback, is that it becomes unreadable in the raw Markdown file, kinda defeating its original idea, but perhaps we could live with that for the sake of a prettier website.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.