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

Cover the whole library with Docs #40

Closed
maximbircu opened this issue Apr 22, 2020 · 0 comments · Fixed by #48
Closed

Cover the whole library with Docs #40

maximbircu opened this issue Apr 22, 2020 · 0 comments · Fixed by #48
Assignees
@maximbircu
Labels
tech CI and workflows

Comments

@maximbircu
Copy link
Owner

Abstract

It would be too hard for library consumers to integrate the library and benefit of all its features without a good documentation.

Requirements

  1. Find the option to store the library API docs
  2. Cover the whole library API with docs

Consumer flow

Make sure the library API docs are accessible, straight forward, and concise.
@maximbircu maximbircu added the tech CI and workflows label Apr 22, 2020
@maximbircu maximbircu self-assigned this Apr 22, 2020
@maximbircu maximbircu mentioned this issue Apr 28, 2020
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@maximbircu maximbircu

Labels
tech CI and workflows
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add library API documentation maximbircu/devtools-library
1 participant
@maximbircu