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.

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

Improve Documentation #19

Open
4 tasks
NULLx76 opened this issue Nov 4, 2020 · 1 comment
Open
4 tasks

Improve Documentation #19

NULLx76 opened this issue Nov 4, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@NULLx76
Copy link
Member

NULLx76 commented Nov 4, 2020

We should expand the current documentation

  • Readme
  • Code Comments
  • API Documentation for http endpoints (possibly with swagger or apidoc)
  • General documentation which contains things such as a high level overview
@NULLx76 NULLx76 added the documentation Improvements or additions to documentation label Nov 4, 2020
@jdonszelmann
Copy link
Member

To increase comments in code, we might want to create a linting configuration for go, so we are forced to

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants