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

Providing documentation for the whole backend #270

Open

3 tasks

MuhammadKhalilzadeh opened this issue Nov 21, 2024 · 1 comment

Open

3 tasks

Providing documentation for the whole backend #270

MuhammadKhalilzadeh opened this issue Nov 21, 2024 · 1 comment

Assignees

Labels

backend documentation

Milestone

Connecting Fronte...

Collaborator

MuhammadKhalilzadeh commented Nov 21, 2024

In this task, you need to:

Review the whole backend code and make sure that each file has comprehensive documentation.
For each routes, you need to provide a documentation that indicates what is exactly the content of the response sent to the frontend.
The Status for each scenario, and also fields inside the body of the response.

MuhammadKhalilzadeh added the backend label

MuhammadKhalilzadeh added this to the Connecting Frontend to Backend milestone

MuhammadKhalilzadeh assigned HarshP4585

MuhammadKhalilzadeh added the documentation label

gorkem-bwl changed the title ~~Providing Documentation for the whole backend~~ Providing documentation for the whole backend

MuhammadKhalilzadeh assigned Ozc-Y

Collaborator Author

MuhammadKhalilzadeh commented Dec 4, 2024

Hi @HarshP4585, @Ozc-Y

Please take care of these one asap guys.
Thank you so much in advance 🙏🏼

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