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

Architecture diagram #225

Open
TomNicholas opened this issue Aug 23, 2024 · 0 comments
Open

Architecture diagram #225

TomNicholas opened this issue Aug 23, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@TomNicholas
Copy link
Member

TomNicholas commented Aug 23, 2024

@maxrjones quite rightfully pointed out that the current and intended relationship between kerchunk, virtualizarr and zarr is pretty complicated, and changing rapidly. He suggested that a visual representation would make it a lot easier for users / other developers to understand.

We could use the c4 model for this, and maybe use mermaid to render it on github in a way that can be easily modifed through PRs. (see also this example)

@TomNicholas TomNicholas added the documentation Improvements or additions to documentation label Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant