APi docs using Minltlify

[ketankauntia]

What problem does this solve?

api is public now. and the api docs require to be setup for the contributors to visit and read properly.

tested it with nextra was shit tbh due to the routing issue.

Narrowed down to Mintlify in the end as the docs template..

If you want to work on it, just ping me or pick it up mentioning in the comments below.

All the api related info will be avaiable in an api . md file in the api route incase you want to an entire overview for easy access.

Proposed solution

No response

[JeelDobariya38]

Is this api intended to be used publicly? I meaning the docs is intended to be read by all developer or just developer of gsoc-orgs... meaning developer working in this organisation or general developers...

Is the api that is exposed publicly is intended to call by anyone? meaning can someone make thier own app using gsoc-orgs app's api (this repos)..

and yup, i am interested in working on this issue, @ketankauntia

if it for third party developer,
I am planning to make openapi.spec so, that anyone can use it.. and then we can use some sort of api docs generator (swagger ui) to get nice ui for it. something like this

if not for third party developer then i guess the api docs currently is well enough... but if you want i can make it better...