Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 task done
frank-zsy opened this issue May 24, 2024 · 2 comments
Open
1 task done

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

frank-zsy opened this issue May 24, 2024 · 2 comments

Comments

@frank-zsy
Copy link
Contributor

Is there an existing issue for this?

  • I have searched existing issues, it hasn't been reported yet

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
Copy link
Member

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
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants