Improve user documentation of the napari plugin

[haesleinhuepf]

The link from the readme to the documentation points at a page...
https://github.com/HenriquesLab/napari-NanoPyx/wiki

... which does not contain information about the napari plugin. Is there some documentation how to use the napari plugin online available?

[brunomsaraiva]

I've changed the documentation link to point to our NanoPyx main repo wiki with a description of each method as well as what each parameters does.
Besides this, the wiki contains a section on installation and how to use the plugin, would this suffice?

[haesleinhuepf]

Besides this, the wiki contains a section on installation and how to use the plugin, would this suffice?

Do you mean this page? It contains only very little information about the plugin. I'm wondering for example, how to do Non-local means denoising using the napari-plugin.

Additional documentation recommendations/ideas:

• For non-coding users, advice might also be useful what to do when results don't look great. How can I judge if results are ok? When shall I increase parameter X, when shall I decrease it?

• I would recommend to have a page for each individual plugin, explaining what it does and what its parameters mean. For example, what does "img ref" mean? And what is "img sr"?
  

• Some plugins, e.g. the drift correction plugin, ask for a table file. Where do I get this table file from? Which file format should it have, what columns must be there? If this information is specified elsewhere, add a link.
  

• Add (a link to) example data to the documentation. This way people can try out the plugin on data it was made for.

Read more about good documentation.

[brunomsaraiva]

Thanks for the examples and link :)
I'll keep the issue open while we improve this side of the documentation, we will do it ASAP.