ome / ome/ngff

better connect scattered documentation (e.g. ome-ngff-tools) with the website

Open
#401 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
171
Forks
75
Avg merge
2d 3h
Merged PRs (30d)
20

Description

https://ome.github.io/ome-ngff-tools/ is a good resource, currently only linked in the ngff website.

it could be embedded or integrated in some other way, so it is more visible to the NGFF community

minimally, adding it on an iframe would not be terrible, but needs some thought

It is related to a discussion at:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the NGFF website and the ome-ngff-tools resource linked in the issue, then read the related discussion at German-BioImaging/ome-zarr-ideas#40. Determine whether the resource should be embedded or linked more prominently, and document the agreed integration and visibility outcome as done.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.