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

Documentation #13

Closed
sgrif opened this issue Nov 28, 2015 · 3 comments
Closed

Documentation #13

sgrif opened this issue Nov 28, 2015 · 3 comments
Milestone

Comments

@sgrif
Copy link
Member

sgrif commented Nov 28, 2015

This is my biggest call to action for anybody interested. While I will absolutely write all the docs if needed, I do strongly believe that the best flow for this is to have people who didn't implement something ask questions, and find usage that way, as it forces an explanation targeted at people not familiar with the framework.

This is by far the biggest blocker for 0.1, and probably the easiest way to get started. If you're interested in helping, comment here, or shoot me an email (it's on my profile). I will take as much time as is needed to explain usage.

@sgrif sgrif added this to the 0.1 milestone Nov 28, 2015
@mikeastock
Copy link
Contributor

I am interested in helping write documentation as I try to use the library! I believe @mcasper is willing to help as well. We are building a simple API backend using Iron and would love to try to use yaqb.

@sgrif
Copy link
Member Author

sgrif commented Nov 28, 2015

@mikeastock Excellent! I'm happy to help however I can. Feel free to ping with any specifics. I'm trying to get the bare minimum getting started stuff out the door tonight.

@sgrif
Copy link
Member Author

sgrif commented Nov 29, 2015

Documentation can always be improved, but I believe we have the minimum acceptable level of documentation for all modules. I think we're good to go for 0.1.

PRs to improve documentation, no matter how minor, are always welcome.

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

2 participants