[TODO] Add some API documentation

[gbowne1]

MWe need some API documentation on how to use the API

Use the /docs/ folder to add API documentation in Markdown

Also they should be added to a section of our Wiki by cloning the Wiki individually and use Markdown to create a section on API.

Add links to documentation in the README.md file

[amritatwal]

Hi Gregory,

I'm interested in helping out with this. I have a particular interest in technical writing. I'm looking for opportunities to practice writing documentation.

Would you be happy for me to contribute?

[gbowne1]

@amritatwal
Yes, this issue is open, so you are welcome to work on this issue or any of the other open documentation issues, and there are several.

I can assign you if you wish to work on this.

[EdwinChukwuebuka]

Hello Gregory and amritatwal, I'm also interested in helping out with this as I'm also looking for opportunities to practice api documentation.
Can I contribute too?

[janetmmiller]

Hi @gbowne1, @amritatwal, @EdwinChukwuebuka,

Has anyone started on the documentation yet? Maybe we could divide the work into assignments? Message me here. Thanks!

[EdwinChukwuebuka]

@janetmmiller not really, just been trying to run the code, understand how it works and test the api on postman.
I should be done with that soon then I'll start the documentation.

[gbowne1]

@janetmmiller There are several people wanting to do documentation.

I do not mind if a group of people get together to talk about and/or do any of the documentation for the API or the app itself.

I would prefer the documentation go on our Wiki but can exist inside the /docs folder

@LOGESH-B did a great deal of the backend so if you need help with database, APIs, backend etc help he can help you.

I have mainly been doing the Project Management role in this app and helping debug.. due to time limits I have.