Quran-Tafseer/tafseer_api

Better Documentation Design

Closed this issue · 4 comments

The initial design is built with simple HTML using bootstrap and Flat-UI theme, we want to have better design docs.

Look into Swagger docs.

if the API is [re]written in OAS/swaggerspec, you'll get a lot for free with swaggerui+generated clients - including better documentation. i've done this before, let me know if you'd like some assistance.

jazakumallahu khair on your work with this project

@amerghazal I want to look into https://www.django-rest-framework.org/topics/documenting-your-api/ and pick the right package, if you like to contribute and help, you can do the research and implement it.

i'll take a stab at this in the coming few days, iA