Add Documentation to Login Endpoint

[William-McGonagle]

Idea

At this point, we have a ton of endpoints and the number just keeps growing. We need to document all of these endpoints but the only way to do that is to write about each of them. That is where you come in. If you would like to document this endpoint, just comment on the post, and I will assign it to you.

Todo

• Add an item to the OpenAPI file that shows how to "Login"
• Add a documentation page about "Login"

[MassiGy]

Hey @William-McGonagle,

I want to help in this one, but my documentation process is based on the jsDoc built-in vsCode comment system.
Is that fine ?

Massiles.

[William-McGonagle]

Hey @MassiGy,

I think that just leaving comments in the code at this point is fine. We are going to get some more people on the project just to manage the documentation, but for now, I think we are good. I am going to look through the issues that we have on the project at the moment and try and address what we should focus on at this point- but you've done great work so far!

Thanks,
William McGonagle

[MassiGy]

Hey @William-McGonagle,

Yeah, thanks for the great feedback, it is just that these days I wanted to learn new skills and documentation will be a good one, so if you liked how I documented with jsDocs, let me know so as I will do more !

Thanks in advance !
Massiles.

[William-McGonagle]

Hey @MassiGy,

I personally love your commenting style and you should focus on whatever you would like to improve- that is why you can pick whatever you would like to focus on.

Thanks,
William McGonagle

[MassiGy]

Hey there, @William-McGonagle

Thanks for the great feedback, I really appreciate it. I will do more of it in the up coming days !

Thanks.
Massiles.