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

Documentation #78

Closed

3 tasks done

wovalle opened this issue Sep 23, 2019 · 0 comments

Assignees

Milestone

Owner

wovalle commented Sep 23, 2019 •

edited

Now that we're approaching v1 release (yeah!) we need to start thinking of writing some type of documentation if we want people to use this library.

I will divide this task in three subtasks which will be worked individually:

Write draft documentation in markdown files
Find and implement a documentation page builder (GitBook? Docusaurus?)
Merge the documentation with the Types documentation (which is generated right now with TypeDoc)

wovalle self-assigned this

wovalle added this to the v1 milestone

This was referenced Sep 23, 2019

Open

Feat: adding documentation #79

Merged

wovalle closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment