Upload User Manual

[MargaretAN9]

Fixes #1162
This is a user manual for Image Sequencer that I have been working on. Any edits or tips would be greatly appreciated. First draft is located at https://publiclab.org/notes/MaggPi/06-10-2019/draft-of-public-lab-image-sequencer-user-manual-comments-welcome.

[codecov]

Codecov Report

Merging #1171 into main will increase coverage by 10.31%.
The diff coverage is 64.31%.

@@             Coverage Diff             @@
##             main    #1171       +/-   ##
===========================================
+ Coverage   55.11%   65.43%   +10.31%     
===========================================
  Files         117      133       +16     
  Lines        2344     2743      +399     
  Branches      360      439       +79     
===========================================
+ Hits         1292     1795      +503     
+ Misses       1052      948      -104     

Impacted Files	Coverage Δ
examples/lib/scopeQuery.js	18.51% <ø> (ø)
src/Modules.js	100.00% <ø> (ø)
src/modules/WebglDistort/Module.js	2.29% <0.00%> (ø)
src/ui/SetInputStep.js	12.90% <0.00%> (-1.39%)	⬇️
src/modules/ColorHalftone/Module.js	3.63% <3.63%> (ø)
examples/lib/defaultHtmlStepUi.js	11.35% <4.08%> (-0.85%)	⬇️
examples/lib/intermediateHtmlStepUi.js	11.11% <5.55%> (+0.94%)	⬆️
examples/lib/insertPreview.js	13.15% <20.00%> (-0.36%)	⬇️
src/util/getImageDimensions.js	20.00% <20.00%> (ø)
src/util/isGif.js	20.00% <20.00%> (ø)
... and 102 more

[jywarren]

Epic!!!!

[harshkhandeparkar]

WOW! I'll go through all of this again.

[Divy123]

This is something really awesome!!
All the modules having a display with the sample image is amazing.

Just one or two points, I think can help here:
Adding docs for newly added Noise reduction and Minify Image module.

Insert step functionality can be demonstrated.

Also we can link the upcoming colorimetry project which can be something like upcoming applications.

[jywarren]

Hi @Divy123 @aashna27 @harshkhandeparkar -- would you mind going through this carefully and leaving feedback, even just 👍 if a section looks good? Thank you!

[jywarren]

One nice thing you can do is add three of the ` character around sections that are code examples, and even ```js above and ``` below, which makes it syntax highlighted for javascript! See the existing README on image sequencer for examples!

[jywarren]

// example code:
do();

[jywarren]

Hi @publiclab/is-reviewers @Divy123 @aashna27 @harshkhandeparkar would you mind reading through some sections here and offering input? Thank you!

[aashna27]

Yeah sure will do it

…

On Sat, Aug 3, 2019, 12:21 PM Jeffrey Warren ***@***.***> wrote: Hi @publiclab/is-reviewers <https://github.com/orgs/publiclab/teams/is-reviewers> @Divy123 <https://github.com/Divy123> @aashna27 <https://github.com/aashna27> @harshkhandeparkar <https://github.com/HarshKhandeparkar> would you mind reading through some sections here and offering input? Thank you! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1171?email_source=notifications&email_token=AGKQ7SHNVVN4E6XI7ETNSQTQCUTFPA5CNFSM4IDR6QG2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD3PIRUI#issuecomment-517900497>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AGKQ7SBWLX454TKCBX3HWR3QCUTFPANCNFSM4IDR6QGQ> .

[harshkhandeparkar]

Wow! This is awesome. So much detail. I would like to suggest a few things.

1. Could we make this more compact? Since this is a user manual, we could exclude the intro.

2. There is a modules.md file for module specific instructions, we could exclude that part and link to it as managing two files will be difficult.

3. Could link to contributing.md instead of a dedicated section. (Or optionally, add it to the footer)

4. Could we link to the beta site (https://beta.sequencer.publiclab.org) with a disclaimer?

5. I think you have added some extra stuff to the modules part, could you please add it directly to the modules.md file?

Thank you!
cc @jywarren @aashna27 @MargaretAN9

[gitpod-io]

[harshkhandeparkar]

It would be better if we put all of this in /docs and split everything into multiple files. Other than that, it is awesome!