Image-sequencer: Improve Documentation : providing more links to the tests.

[Divy123]

Please describe the problem (or idea)

Improvement of Documentation and providing links to the tests.

I suggest to use Read the Docs for a nice documentation.

Also there can be two different docs : one for usage and other a somewhat elaborate explanation of functions defined and the work flow. This can make the contributions easier for all.
Thanks!

[Divy123]

@jywarren want to draw your attention upon this.
Also I would like to suggest that to increase the reach of the project and to have a better community experience, we can translate the documentaion to various languages.
This can be a community based issue and can be carried out across all of our projects.
Cc: @gauravano @tech4GT @SidharthBansal @HarshKhandeparkar

[harshkhandeparkar]

How can the docs be translated? Secondly, the code itself is in English, I mean we can translate the docs or the demo site but the docs have code examples, what about those?

[Divy123]

So we can have a different repo for this which can have docs for all the projects.
And about the code part they will remain as it is i.e. in the programing langauge they are in.
Though I think the comments can be translated.
Like React are also doing these days:
https://github.com/reactjs

[harshkhandeparkar]

Ok that is a great idea!

[jywarren]

Whoa, this is a very cool idea! Wow, can you point at their repository
where they've posted such translated comments so we can browse how they're
structured?

Thank you for a great suggestion!!!

On Tue, Mar 26, 2019 at 3:30 PM Slytherin [e-mail] wrote:

@jywarren https://github.com/jywarren want to draw your attention upon
this.
Also I would like to suggest that to increase the reach of the project and
to have a better community experience, we can translate the documentaion to
various languages.
This can be a community based issue and can be carried out across all of
our projects.
Cc: @gauravano https://github.com/gauravano @tech4GT
https://github.com/tech4GT @SidharthBansal
https://github.com/SidharthBansal @HarshKhandeparkar
https://github.com/HarshKhandeparkar

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/publiclab/image-sequencer/issues/753#issuecomment-476811957,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AABfJ9Jsd1yAewzKu-Yn7mzcX3zF1ZaYks5vanUrgaJpZM4ax-9i
.

[grvsachdeva]

Nice idea @Divy123!

[Divy123]

Sorry to be late. I was travelling.
https://fr.reactjs.org/tutorial/tutorial.html.
Please have a look here @jywarren .
The last line is the translated comment.

This is the french version here.

[Divy123]

Here is a link to the repo:
https://github.com/reactjs

[harshkhandeparkar]

@Divy123 do they use some kind of framework to so the translation?

[harshkhandeparkar]

Actually the repo we want to see is this
https://github.com/reactjs/reactjs.org