codecommunitymusic-client icon indicating copy to clipboard operation
codecommunitymusic-client copied to clipboard

[Feature] Docs for contributors

Open Abbhiishek opened this issue 1 year ago • 6 comments

Hello,

This project has a backend service made purely in django and postresql db. The api and methods are not clear and its difficult for new bies to get started with the project.

Solution

We can host an external docs page backed by us to provide an open environment to test the api and use limited api calls. The docs would include all the details about the request body and response schema which might help me developer to get started with the project :)

Leaving this issue as a discussion on how we can aim this feature and proceed with the stuff.

Abbhiishek avatar Sep 28 '23 14:09 Abbhiishek