Use apidoc for Api documentation

Open YashKumarVerma opened this issue 5 years ago • 5 comments

Since BOSS has an API, it should have proper documentation written in a standard format like APIDocs.

Working on it after confirmation

May 16 '20 11:05 YashKumarVerma

I've assigned the bounties for these tasks

[ ] 100 Bounty: Writing the api docs
[ ] 200 Bounty: Setup api doc generator to build and publish api docs to gh-pages

May 17 '20 14:05 abhishek97

@abhishek97 #241 needs to be resolved first for it

May 17 '20 15:05 YashKumarVerma

we can use apidoc for this

May 17 '20 19:05 abhishek97

we can use apidoc for this

thanks, starting to work on it

May 17 '20 19:05 YashKumarVerma

@abhishek97 quick question, this documentation has be for the routes in api.js right ?

May 18 '20 10:05 YashKumarVerma