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

document client feature support #71

Closed
will-moore opened this issue Nov 2, 2021 · 5 comments
Closed

document client feature support #71

will-moore opened this issue Nov 2, 2021 · 5 comments

Comments

@will-moore
Copy link
Member

will-moore commented Nov 2, 2021

As the spec evolves, it's increasing likely that there will be parts of it that are not supported by all the clients, either because of technical limitations or the work just hasn't been done/released.

It would be really nice for new and existing users to be able to see what is supported by which clients, or what's NOT supported (without having to search the issues of each repo). This would also be a nice way to show what clients are available to view OME-NGFF data.

I'm thinking of something like a support table, similar to e.g. https://caniuse.com/flexbox (although in that case it's a table for a single feature, with different versions of each tool). I'd suggest we limit it to documenting only the latest release of each tool.

viewer Z-downsampling omero info multiscales factor not=2 URL (not s3) v0.3 axes 3D view labels HCS plate
napari y y y y y y (1) y y
vizarr n y n y y n n y
MoBIE y n y n n y y n
  1. napari 3D view only supported for lowest level of multiscales pyramid

If this looks like a popular idea, where would this doc/table live? Include it in the spec page, or a doc page on this repo?

@joshmoore
Copy link
Member

cc: @manzt @constantinpape

@constantinpape
Copy link
Contributor

This would be great to have!

@manzt
Copy link

manzt commented Nov 4, 2021

Agreed, great idea! This table is already useful to point to (and have the information collected). I especially like how the links in the table above provide a nice preview prior discussion.

I guess the question is whether it should live under a separate domain/site (e.g. https://ome.github.io/caniuse). However, my vote would be to keep this information in markdown on a table on GitHub. Easy to update, includes rich integration with GitHub issues/PRs, and the features listed currently are fairly technical.

@joshmoore
Copy link
Member

https://github.com/ome/ngff/blob/main/caniuse.md would be one option. Another might be https://nicolas-van.github.io/easy-markdown-to-github-pages/

👍 for getting something in place ASAP.

cc: @tischi

@will-moore
Copy link
Member Author

See https://ome.github.io/ome-ngff-tools/

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

4 participants