search

einnar82 / mpl-ph-api

Get the latest MPL-PH Updates from https://ph-mpl.com/
5 stars 11 forks source link

Enhance documentation #5

Open einnar82 opened 3 years ago

einnar82 commented 3 years ago

I'm a believer of "Great product comes with great documentation."

Create a straightforward documentation for the API.

kumaranshu72 commented 3 years ago

Can I pick this up?

einnar82 commented 3 years ago

Yes you can, @kumaranshu72 . Currently the API is on development stage. Better to wait for the other PRs regarding the api endpoints.

Thanks

kumaranshu72 commented 3 years ago

@einnar82 In the meanwhile I can add up swagger. I will add Js-docs so that anyone can add the comments and documentation will be self-generated. Let me know if I can go ahead with it.

einnar82 commented 3 years ago

Thank you for the suggestion,

For the meantime. You may document about the development setup like installation process etc. 😉

sauravsolanki commented 3 years ago

@einnar82 I am worked on swagger for around 5 months.. Can I add here? It will pretty good to start initially with Swagger and add in contribution guides and let PRs member know how to add your API in swagger.

sauravsolanki commented 3 years ago

Please assign me this @einnar82