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

Add more extensive documentation #3

Open
AriTheElk opened this issue Nov 10, 2016 · 1 comment
Open

Add more extensive documentation #3

AriTheElk opened this issue Nov 10, 2016 · 1 comment

Comments

@AriTheElk
Copy link
Owner

Currently the documentation is extremely lacking. All there is, is a basic usage example without much explanation. Each component and utility should be carefully documented listing all the accepted arguments along with expected outputs.

@AriTheElk AriTheElk added this to the v1.0.0 Release milestone Nov 11, 2016
@AriTheElk
Copy link
Owner Author

I'm currently looking into ESDoc as a possible solution for automatic documentation generation. Going to be doing more research into it to see if it's the best doc solution for this project.

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

No branches or pull requests

1 participant