Documentation of MODULES is incomplete

[oorjitchowdhary]

Please describe the problem (or idea)

MODULES.md is complete.
It has information only about 3 modules which are:-

• Crop Module
• FisheyeGI
• Colormap

We can add information about the other modules as well so it is a complete file.
Also, when someone adds a new module, he/she could also add info about it here.

This could be a good documentation issue for newcomers or maybe frequent contributors too.
@publiclab/mentors what say? 😄

Please show us where to look

https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md

What's your PublicLab.org username?

oorjit_chowdhary

Browser, version, and operating system

Chrome, Windows 10

---

Thank you!

Your help makes Public Lab better! We deeply appreciate your helping refine and improve this site.

To learn how to write really great issues, which increases the chances they'll be resolved, see:

https://publiclab.org/wiki/developers#Contributing+for+non-coders

[gitmate]

GitMate.io thinks possibly related issues are #337 (Add a list of available modules to the documentation), #188 (Add a list of working modules and their parameters in the documentation), #5 (image cropping module), #367 (Create Contrast Module), and #285 (Colorbar generation module).

[gitmate]

GitMate.io thinks possibly related issues are #337 (Add a list of available modules to the documentation), #188 (Add a list of working modules and their parameters in the documentation), #5 (image cropping module), #367 (Create Contrast Module), and #285 (Colorbar generation module).

[oorjitchowdhary]

@jywarren @aashna27 @Paarmita @Rishabh570

[jywarren]

this would be good but I wonder if documentation may focus on the info.json files of each module. Would it be possible to add more documentation there, rather than compiled into one place? Or perhaps there should be a short documentation in the info.json (and the description shown on the demo) but it could provide a link to the MODULES.md file on the web, to read a longer-form documentation there?

…

On Sat, Dec 1, 2018 at 12:51 PM Oorjit Chowdhary ***@***.***> wrote: @jywarren <https://github.com/jywarren> @aashna27 <https://github.com/aashna27> @Paarmita <https://github.com/Paarmita> @Rishabh570 <https://github.com/Rishabh570> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#506 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABfJ7rMIrukB8-I5nQGzCMo2SU0D_Ttks5u0sGTgaJpZM4Y6-L7> .

[oorjitchowdhary]

@jywarren I found the doc with only three modules so I pointed it out..
Yes, I think providing a link to MODULES.md would be better.. It'd be a neat and clean way of organizing our repo and describing the modules too

[Divy123]

@oorjitchowdhary Can I please take up this issue?

[tech4GT]

Sure divy!😁