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.

Sign up for GitHub

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

Jump to bottom

[5pt] - Project documentation #4

Open

3 of 8 tasks

Nemwel-Boniface opened this issue Apr 2, 2023 · 0 comments

Assignees

Labels

Owner

Nemwel-Boniface commented Apr 2, 2023 •

edited

Loading

In this milestone, I am supposed to update the project README and add the project documentation. The sections that need to be highlighted include:

Overview of the project and what it is all about and its goals
How to setup the project and run it locally
First version of the README DONE in My kuku Milestone 1 : Setup #1
How to run the unit tests
Any extra installations needed to make the project run locally
Add the projects API endpoints and sample endpoints with the data it accepts/ receives or gives out
Advanced version of the project README
Finalized version of the README

Nemwel-Boniface self-assigned this

Nemwel-Boniface added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment