Use apidoc for Api documentation

coding-blocks / boss

BOSS Leaderboard and Claims API and website

https://boss.codingblocks.com

26 stars 154 forks source link

Open YashKumarVerma opened 4 years ago

YashKumarVerma commented 4 years ago

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

Working on it after confirmation

abhishek97 commented 4 years ago

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

YashKumarVerma commented 4 years ago

@abhishek97 #241 needs to be resolved first for it

abhishek97 commented 4 years ago

we can use apidoc for this

YashKumarVerma commented 4 years ago

we can use apidoc for this

thanks, starting to work on it

YashKumarVerma commented 4 years ago

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