Add a list of working modules and their parameters in the documentation

[tech4GT]

If someone wishes to browse our modules one would have to go through the info.json file of every module. We can simplify this by having a list of modules and the their info in the README itself.
@jywarren what say?

[jywarren]

GitMate.io thinks the contributors most likely able to help are @jywarren, and @ccpandhare.

[jywarren]

can we reduce redundancy at all? What if we have a list in README of modules, each of which links to their respective info.json files for more? good thinking!

…

On Thu, Feb 22, 2018 at 2:01 PM, Varun Gupta ***@***.***> wrote: If someone wishes to browse our modules one would have to go through the info.json file of every module. We can simplify this by having a list of modules and the their info in the README itself. @jywarren <https://github.com/jywarren> what say? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#188>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABfJ7xJIHm7kg-qgg4VPHpYbhF9pWrxks5tXbmKgaJpZM4SP0R3> .

[tech4GT]

@jywarren sure, that can be done😁

[ccpandhare]

Yes, having all that into the readme wouldn't be a good idea, I feel.
The readme needs a bit reworking itself, I do feel at times that it's pretty long!

[tech4GT]

@ccpandhare yes i share the view so what i was thinking was maybe we can make a note on publiclab.org and link it here for someone who wishes to browse through all the modules kind of like we handle the bookmarklet...what say?

[ccpandhare]

I'm not sure how that'll work out... @jywarren isn't it?

…

On Fri, Mar 2, 2018, 10:49 Varun Gupta ***@***.***> wrote: @ccpandhare <https://github.com/ccpandhare> yes i share the view so what i was thinking was maybe we can make a note on publiclab.org and link it here for someone who wishes to browse through all the modules kind of like we handle the bookmarklet...what say? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#188 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AT0xnLa6r5lkPDS0bBTI6AKATD6b1cXMks5taNZsgaJpZM4SP0R3> .

[tech4GT]

@ccpandhare what if we shorten the readme and leave it bare bones and create a comprehensive documentation separately like many packages with large documentation do...will that be better?
We can have something like read full reference link in readme

[jywarren]

We can link into additional Markdown files in a /docs/ folder... what do you think? Like on plots2!

…

On Fri, Mar 2, 2018 at 1:26 AM, Varun Gupta ***@***.***> wrote: @ccpandhare <https://github.com/ccpandhare> what if we shorten the readme and leave it bare bones and create a comprehensive documentation separately like many packages with large documentation do...will that be better? We can have something like read full reference link in readme — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#188 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABfJzpFx3y7_EbR6N5jGl9AjAJpRmQmks5taOYmgaJpZM4SP0R3> .

[ccpandhare]

I do agree with Varun on this..!

…

On Sat, Mar 10, 2018, 03:38 Jeffrey Warren ***@***.***> wrote: We can link into additional Markdown files in a /docs/ folder... what do you think? Like on plots2! On Fri, Mar 2, 2018 at 1:26 AM, Varun Gupta ***@***.***> wrote: > @ccpandhare <https://github.com/ccpandhare> what if we shorten the readme > and leave it bare bones and create a comprehensive documentation separately > like many packages with large documentation do...will that be better? > We can have something like read full reference link in readme > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > < #188 (comment) >, > or mute the thread > < https://github.com/notifications/unsubscribe-auth/AABfJzpFx3y7_EbR6N5jGl9AjAJpRmQmks5taOYmgaJpZM4SP0R3 > > . > — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#188 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AT0xnMP1eYO3jSsEGFqCOMg-rsYUtekzks5tcv16gaJpZM4SP0R3> .

[tech4GT]

@ccpandhare thanks @jywarren totally we can do that👍

[harshkhandeparkar]

Docs were updated through #506. Closing this