search

ritwik12 / Virtual-Assistant

A linux based Virtual assistant on Artificial Intelligence in C
GNU General Public License v3.0
128 stars 95 forks source link

Create Documentation #66

Open ritwik12 opened 5 years ago

ritwik12 commented 5 years ago

Every feature of Virtual Assistant have its unique implementation such as the implementation for Restaurant, Weather, Google search, Email and Media is different for each.

To understand better it will be good to have Docs related to the working of these.

ritwik12 commented 5 years ago

@jackycodes If you are still looking for some work, please have a look.

ritwik12 commented 5 years ago

@GaelleMarais @LilyaMel If you have spare time and Interested, please write a Doc for Email.

Exter-dg commented 5 years ago

I would like to work, but i have never written any documentation before this. Can i still help?

riya-17 commented 5 years ago

@Exter-dg sure you can always contribute

Grace-Morales commented 4 years ago

I would like to help create a Doc for any of the features, is there any I can work on? I have not done this before, but I'm willing to do my best and work hard.

ritwik12 commented 4 years ago

@Grace-Morales Thanks for taking an interest. We have tried our best to make the README.md as explainable as possible but for now we only have how to use the features and not how they work And with respect to that we need the working of Restaurants, Emails, Search, Media and etc features. How it works and all the things in the readme section only. Can you try to go through the PR and code sent for this feature and if you can write documentation for that. Also, if you see anything that is not there in Readme or needs work. Please go ahead and open an issue for that, we will be happy to have PRs. If you ever need help, please let us know.

Grace-Morales commented 4 years ago

So you just want me to go through the README.md and write documentation for how the features are going to work? Also, just to clarify, by PR do you mean pull request? Thank you for getting back to me.

ritwik12 commented 4 years ago

@Grace-Morales Yes. Pull request

jake-schmidt99 commented 4 years ago

Hi there! If I could help with the documentation process. I'm still relatively new to coding so I feel like this would be the best way for me to help out with the project.

ritwik12 commented 4 years ago

@jake-schmidt99 Please go ahead, I see that you have already sent a PR. Thanks!!