Skip to content

DOC: Add open source diagram tooling #11214

@VeckoTheGecko

Description

@VeckoTheGecko

Is your feature request related to a problem?

Some concepts in Xarray may be difficult to understand without visualizations, however vizualizations are currently hard to maintain and update (e.g., if its created using proprietary software, or if the file stored in the repo is the exported file instead of the original source file).

Having tooling to automatically build source outputs and use those outputs in the documentation would be really helpful.

Describe the solution you'd like

We can use https://kroki.io/ which allows us to create diagrams from a whole range of textual descriptions listed here https://kroki.io/#support

Image

Pixi makes this sort of thing really easy (especially the https://prefix.dev/channels/github-releases channel, which pretty much makes any binary released on GitHub Pixi installable).

This issue is mostly lifted from Parcels-code/Parcels#2532

Describe alternatives you've considered

No response

Additional context

Are diagrams something that we would benefit from? One example is #11031 , any others?

cc @ianhi

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions