pelkmanslab / CellProfilerPelkmans

A fork of CellProfiler1.0 developed by members of Pelkmans Lab https://www.pelkmanslab.org
GNU General Public License v2.0
1 stars 1 forks source link

Suggestions of documentation linking/organization #18

Open ewiger opened 9 years ago

ewiger commented 9 years ago

Linking from the README.md

Modules API Documentation. It is updated automatically daily, and contails all modules.

Automatically generated docs form the source code. Very good. We should keep it.

Core Module help. A subset of core modules

This is linked by mistake to iBRAIN UZH core modules. This should a standard modules.

CellProfiler manual. Standard modules only.

CellProfilerPelkmans Wiki. Custom modules only.

When I am clicking here I see very short module descriptions. I suggest that each module gets linked to automatically generated documentation for the source code.

List of Standard Modules. Standard modules only.

The difference between standard and custom modules is not explained. How are they developed, maintained, etc.

How to update documentation

Instructions are missing on how to update documentation if the module has been changed.