Skip to content

Use apidoc for Api documentation #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
YashKumarVerma opened this issue May 16, 2020 · 5 comments · May be fixed by #290
Open

Use apidoc for Api documentation #239

YashKumarVerma opened this issue May 16, 2020 · 5 comments · May be fixed by #290
Labels
BOSS BOUNTY: 100 BOUNTY: 200

Comments

@YashKumarVerma
Copy link
Contributor

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

Working on it after confirmation
@abhishek97
Copy link
Contributor

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
Copy link
Contributor Author

@abhishek97 #241 needs to be resolved first for it

@abhishek97 abhishek97 changed the title API Documentation Missing Use apidoc for Api documentation May 17, 2020
@abhishek97
Copy link
Contributor

we can use apidoc for this

@YashKumarVerma
Copy link
Contributor Author

we can use apidoc for this

thanks, starting to work on it

@YashKumarVerma
Copy link
Contributor Author

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

YashKumarVerma added a commit to YashKumarVerma/boss that referenced this issue May 18, 2020
@YashKumarVerma
Documenting API and integrating apidocs :Fixes coding-blocks#239
4990bec
YashKumarVerma added a commit to YashKumarVerma/boss that referenced this issue May 18, 2020
@YashKumarVerma
Documenting API and integrating apidocs :Fixes coding-blocks#239
8eeff47
@YashKumarVerma YashKumarVerma linked a pull request May 18, 2020 that will close this issue
Open
2 tasks
YashKumarVerma added a commit to YashKumarVerma/boss that referenced this issue May 18, 2020
@YashKumarVerma
Documenting API and integrating apidocs :Fixes coding-blocks#239
1eb3516
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
BOSS BOUNTY: 100 BOUNTY: 200
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Documenting API and integrating apidocs YashKumarVerma/boss
2 participants
@abhishek97 @YashKumarVerma