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

Sparse Documentation #68

Open
garbagetrash opened this issue Feb 15, 2019 · 2 comments
Open

Sparse Documentation #68

garbagetrash opened this issue Feb 15, 2019 · 2 comments
Assignees

Comments

@garbagetrash
Copy link
Collaborator

The documentation seems pretty sparse. Probably should make a concerted effort to comb through it and add where you can. Since 'improve documentation' is a pretty vague goal we should discuss some kind of boxed boundaries for the scope of this, or maybe just vote on whether it's good enough or something.

Anyways, I feel like we can do a bit better here.

@garbagetrash garbagetrash changed the title Poor Documentation Sparse Documentation Feb 15, 2019
@ostrosco ostrosco self-assigned this Feb 15, 2019
@ostrosco
Copy link
Owner

I think one of the big things we need is a straight up tutorial for our two most common use cases: users wanting to hook up existing nodes into a graph and users who want to write their own nodes using the existing infrastructure. I'll figure out the best way to do that.

@garbagetrash garbagetrash self-assigned this Feb 16, 2019
@garbagetrash
Copy link
Collaborator Author

garbagetrash commented Feb 16, 2019

Sounds good to me!

I'll work on filling out some of the documentation for the existing modules. I just finished up with the util module, and spammed a bunch of new issues for the remaining modules. This issue can be for your part. I'll assign myself to the newly spammed issues as I work them.

@garbagetrash garbagetrash removed their assignment Feb 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants