EnvisEdge icon indicating copy to clipboard operation
EnvisEdge copied to clipboard

📚 Documentation: Removing grammartical errors from Readme.md file

Open prakharshreyash opened this issue 2 years ago • 10 comments

🙋 Where

Readme.md file

💭 Description

Readme.md file has many grammartical errors which I will fix.

👀 Have you spent some time to check if this issue has been raised before?

  • [X] I checked and didn't find similar issue

🏢 Have you read the guidlines?

  • [X] I have read the Guildlines

🏢 Have you read the Code of Conduct?

  • [X] I read the Code of Conduct

prakharshreyash avatar May 03 '22 01:05 prakharshreyash

I would be happy if this is assigned to me

Muhtoyyib avatar May 03 '22 03:05 Muhtoyyib

Hey @prakharshreyash, Thanks for proposing this issue can you elaborate upon the fixed that you are proposing on the README.md file. Thanks

ramesht007 avatar May 03 '22 05:05 ramesht007

The README.md file is a great introduction EnvisEdge Documentation but I think it needs a little changes. Below is a list of the changes I would love to make to the file.

  1. I thought it would be good to present all the "edge computing" in the file with the word 'edge' starting with a capital letter to give readers more insights about Edge Computing. Many beginners don't know what edge computing is and leaving it that way could bring about some confusion.
  2. The paragraph, "We presume that the technical writer assigned to this project has no prior knowledge of NimbleEdge or its community. This means time will need to be built into the project plan at the start to get familiar with it. Mentors will provide walkthroughs, set up time for discussing with or interviewing different kinds of end-users and content experts. We are open to listening to writers' suggestions and contributions." should be highlighted or maybe put in a blockqoute to draw the attention of readers to it. This will increase interests of writers who have no prior knowledge about this community. Many are not aware they can work on this project without prior knowledge and navigate out of the page after reading a few lines from the top.
  3. The application form link in this paragraph, "Note: We'll be only considering the applications from this application form, please make sure you have completed all the steps before submitting the application form." should be limited to one I think. I will change this sentence to: "Note: We'll be only considering the applications from this application form, please make sure you have completed all the steps before submitting the form.

These are what I would like to change in this file.

Muhtoyyib avatar May 03 '22 05:05 Muhtoyyib

@ramesht007 I have fixed some grammatical errors that were there in the Readme file. Kindy review my PR. Thanks.

prakharshreyash avatar May 03 '22 06:05 prakharshreyash

Hi @Muhtoyyib! Thanks for sharing the changes you wanna make in the README.md file, please submit a pull request if you wanna contribute.

souravcipher avatar May 04 '22 05:05 souravcipher

@souravrhythm has this been assigned to anyone, can I contribute to this?

Roxie-32 avatar May 05 '22 07:05 Roxie-32

go ahead @Roxie-32 you can take up this issue.

ramesht007 avatar May 09 '22 02:05 ramesht007

hey @ramesht007 I have spotted many grammatical errors, I would like to work on this, can you assign it to me

Balajithegr8 avatar Oct 07 '22 07:10 Balajithegr8

hey @ramesht007 I have spotted many grammatical errors, I would like to work on this, can you assign it to me

Hey @Balajithegr8 , can you put up a PR then I will assign you the issue. thanks

ramesht007 avatar Oct 12 '22 12:10 ramesht007

Hey @ramesht007 I have created the pull request as you requested. Can you accept it and assign it to me? i have one more question - it is related to hacktober fest also right?. Have a good day.

On Wed, Oct 12, 2022 at 5:50 PM Ramesht Shukla @.***> wrote:

hey @ramesht007 https://github.com/ramesht007 I have spotted many grammatical errors, I would like to work on this, can you assign it to me

Hey @Balajithegr8 https://github.com/Balajithegr8 , can you put up a PR then I will assign you the issue. thanks

— Reply to this email directly, view it on GitHub https://github.com/NimbleEdge/EnvisEdge/issues/204#issuecomment-1276071686, or unsubscribe https://github.com/notifications/unsubscribe-auth/AV7FRFRQFJOL6UHQ6NM3CTLWC2UIVANCNFSM5U5RAG7Q . You are receiving this because you were mentioned.Message ID: @.***>

Balajithegr8 avatar Oct 13 '22 15:10 Balajithegr8