Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Documentation : providing more links to the tests. #753

Open
Divy123 opened this issue Feb 8, 2019 · 10 comments
Open

Improve Documentation : providing more links to the tests. #753

Divy123 opened this issue Feb 8, 2019 · 10 comments

Comments

@Divy123
Copy link
Member

Divy123 commented Feb 8, 2019

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
Copy link
Member Author

Divy123 commented Mar 26, 2019

@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
Copy link
Member

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
Copy link
Member Author

Divy123 commented Mar 26, 2019

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
Copy link
Member

Ok that is a great idea!

@jywarren
Copy link
Member

jywarren commented Mar 26, 2019 via email

@grvsachdeva
Copy link
Member

Nice idea @Divy123!

@Divy123
Copy link
Member Author

Divy123 commented Mar 29, 2019

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.
reactss

This is the french version here.

@Divy123
Copy link
Member Author

Divy123 commented Mar 29, 2019

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

@harshkhandeparkar
Copy link
Member

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

@harshkhandeparkar
Copy link
Member

harshkhandeparkar commented Mar 29, 2019

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

@jywarren jywarren added this to the Core improvements milestone May 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants