Skip to content
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

Enhance documentation #5

Open
einnar82 opened this issue Oct 1, 2020 · 6 comments
Open

Enhance documentation #5

einnar82 opened this issue Oct 1, 2020 · 6 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed

Comments

@einnar82
Copy link
Owner

einnar82 commented Oct 1, 2020

I'm a believer of "Great product comes with great documentation."

Create a straightforward documentation for the API.
@einnar82 einnar82 added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers hacktoberfest labels Oct 1, 2020
@kumaranshu72
Copy link

Can I pick this up?

@einnar82
Copy link
Owner Author

einnar82 commented Oct 1, 2020

Yes you can, @kumaranshu72 . Currently the API is on development stage. Better to wait for the other PRs regarding the api endpoints.

Thanks

@kumaranshu72
Copy link

@einnar82 In the meanwhile I can add up swagger. I will add Js-docs so that anyone can add the comments and documentation will be self-generated. Let me know if I can go ahead with it.

@einnar82
Copy link
Owner Author

einnar82 commented Oct 1, 2020

Thank you for the suggestion,

For the meantime. You may document about the development setup like installation process etc. 😉

@sauravsolanki
Copy link

sauravsolanki commented Oct 1, 2020 •
edited
Loading

@einnar82 I am worked on swagger for around 5 months.. Can I add here? It will pretty good to start initially with Swagger and add in contribution guides and let PRs member know how to add your API in swagger.

@sauravsolanki
Copy link

Please assign me this @einnar82

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kumaranshu72 @sauravsolanki @einnar82