Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.
Sign upDocumentation #13
Comments
sgrif
added this to the 0.1 milestone
Nov 28, 2015
sgrif
added
the
good first issue
label
Nov 28, 2015
This comment has been minimized.
|
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. |
This comment has been minimized.
|
@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. |
This comment has been minimized.
|
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. |
sgrif
closed this
Nov 29, 2015
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
sgrif commentedNov 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.