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

Feature: Documentation #32

Open
unna97 opened this issue Jan 8, 2024 · 0 comments
Open

Feature: Documentation #32

unna97 opened this issue Jan 8, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@unna97
Copy link
Owner

unna97 commented Jan 8, 2024

Is your feature request related to a problem? Please describe.
Need an improved technical documentation. Technical documentation to facilitate not just product usage but also related to contributions.

Describe the solution you'd like

  1. README.md : Describe easy installation and setup.
  2. Product Documentation: How to use the annotator + the different features available
  3. Contributing guidelines and a code of conduct;
  4. Code documentation: documentation inside each function (for function definition) & file , API documentation using swagger
  5. Project documentation: Documentation on approach chosen & it's reasoning should be included.

Additional context
https://jamesg.blog/category/advent-of-technical-writing/

@unna97 unna97 added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Jan 9, 2024
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 enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant