search

X-lab2017 / open-digger-website

Official Website for OpenDigger Community
https://open-digger.cn
Apache License 2.0
6 stars 6 forks source link

[Feature] Implement a new architecture SVG image for OpenDigger #21

Open frank-zsy opened 3 months ago

frank-zsy commented 3 months ago

Is there an existing issue for this?

Use case description

Since after the refactor of documentation, we will move each part of the documentation into different pages like metrics and applications. So we should have an interactive architecture SVG in top level README for users to better understand OpenDigger.

Proposed solution (optional)

We can refer to the architecture SVG of Hypertrons: https://blog.frankzhao.cn/images/arch.svg , the SVG file contains elements layouts, styles and interactive script, so it can be interactive and can support multiple languages at once.

Although this SVG file can not be properly rendered in GitHub markdown file due to security reason, we can embed the image in the website

Neilblaze commented 3 months ago

We can have two variants of the same SVG image, one for ZH (default) and the other EN, and we can conditionally render either of them as per the currentLocale of the website. Curious, is the image of the architecture SVG of Hypertrons updated?

frank-zsy commented 3 months ago

The image is just an experiment SVG image and not updated now. But actually the image also accepts parameters which can effect the behavior of the image like you can use this URL (https://blog.frankzhao.cn/images/arch.svg?lang=zh&bg_color=green) to get an image with zh language by default and set the background color to green. So pass parameter to SVG image is also feasible.