[TODO] Add some API documentation
gbowne1 opened this issue · comments
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
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?
@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.
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?
Hi @gbowne1, @amritatwal, @EdwinChukwuebuka,
Has anyone started on the documentation yet? Maybe we could divide the work into assignments? Message me here. Thanks!
@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.
@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.
Thanks Gregory.
I'd love to still help but I can no longer commit enough time to do this. I'm going to un-assign myself from the issue.
@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.
so we need navigations like where are the endpoints, and what documentation does this project need. How would you see a brief debriefing to get up up to speed on what the documentation requires. @gbowne1
@Chizobaonorh, @EdwinChukwuebuka etc.
Several things..
There are some documentation in Docs.
I would like some of the same documentation to appear in the Wiki which can be used for API Documentation, User Documentation and Developer Documentation. Wiki
I did not write the API for this application @LOGESH-B did so API documentation can be directed to him, but I am sure others might be able to chime in.
My goals for both the /docs directory/folder and the Wiki is:
- User Documentation (How to actually use the application as a user)
- API Documentation (how to test and use the applications' internal API)
- Developer Documentation (Getting the project cloned/forked, installed, setting up the database, etc).
There are several issues related to documentation. The are:
Okay @gbowne1
@EdwinChukwuebuka @Chizobaonorh etc
There is also the issue of some of the other Markdown files included in this project which are not terribly accurate or complete.
-
CONTRIBUTING.md
which is the documentation on how to contribute to this project including how to contribute/do PR's, submit issues, submit discussions, clone/fork on GitHub. I would suggest reading it too. -
README.md
which is the main project readme which should have links to relevant contribution and other documentation. -
DEVSETUP.md This file was meant to be instructions on how to get the project installed, cloned, forked, and the database connected and how to run the app.
Right now its basically generic React instructions which are outdated
@EdwinChukwuebuka @Chizobaonorh etc
There is also the issue of some of the other Markdown files included in this project which are not terribly accurate or complete.
- CONTRIBUTING.md
which is the documentation on how to contribute to this project including how to contribute/do PR's, submit issues, submit discussions, clone/fork on GitHub. I would suggest reading it too.- README.md
which is the main project readme which should have links to relevant contribution and other documentation.- DEVSETUP.md This file was meant to be instructions on how to get the project installed, cloned, forked, and the database connected and how to run the app.
Right now its basically generic React instructions which are outdated
If its is basically generic React instructions which are outdated, what guide can i use to setup my workspace?
@Chizobaonorh @EdwinChukwuebuka I would prefer people use my Slack. I don't use Discord for this purpose.
Slack is free. Here is the link.
https://join.slack.com/t/connectcoders/shared_invite/zt-23ajnvegn-0nUuIlxhSDU8tQrPBL~riQ
I will love to join in this project as i am looking forward to gain more experience, pls can i join the contributors? @gbowne1
@Believet2 well, we aren't really ready for documentation yet and there already is some.
Ok
Hey, @gbowne1
Is this API documentation issue still open? I didn´t find any API documentation. Is it a REST API? I would like to contributing.
-
Yes its still open. Any issues that are still left are still open.
-
Theres only installation instructions
-
Yes you can work on them.
-
we are putting all our documentation in the Wiki page but there is some documentation in /docs
-
if you want to work on the Wiki go to the Wiki tab and clone or fork the wiki.
-
I will assign you if yiu wanted to work on this