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

Improvising the documentation #49278

Closed
amulyaashetty opened this issue May 1, 2022 · 7 comments
Closed

Improvising the documentation #49278

amulyaashetty opened this issue May 1, 2022 · 7 comments
Assignees

Comments

@amulyaashetty
Copy link

Improvising the readme of the repository

🐞 Problem
The existing readme of the project has a clustered readme file

🎯 Goal
Improvising the existing readme file , adding instructions and guidelines in a uniform and impressive way and making the documentation more creative

@gokultp
Copy link
Member

gokultp commented May 2, 2022

Can you suggest a format for this @amulyaashetty. Assigning this issue to you

@amulyaashetty
Copy link
Author

@gokultp I am using markdown to write the readme file.

@gokultp
Copy link
Member

gokultp commented May 3, 2022

@amulyaashetty You mentioned about adding instructions and guidelines in a uniform and impressive way. I mean to ask what is that uniform way. Can you suggest the format for that.

@amulyaashetty
Copy link
Author

I would like to add the aim of this github community the goal and description,, of the repsitory. Adding more description on how to install git in a beginners system.
I want to include the steps for forking and cloning the repository in a presentable manner with more images and commands.

@Roshanjossey
Copy link
Member

@amulyaashetty, Please take a look at #35892

I think your suggestions conflicts with the design we have. We're open to suggestions, but please think more about what users want.

@amulyaashetty
Copy link
Author

amulyaashetty commented May 6, 2022 via email

@MaryShodiya
Copy link

@gokultp please can you take a look at my contribution, I translated the read me to Yoruba language, a major language in Nigeria, I noticed it wasn’t part of the available translated languages. Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants