Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Documentation help needed. #19
I'm rewriting Plezi, but rewriting the documentation is far from being my forte... for one, I'm not a native English speaker.
If you want to write a tutorial or add documentation for the Ruby code, please jump in.
You'll need to fork this project for adding YARD documentation using code comments or fork the documentation web application if you're writing any tutorials or help articles.
Help articles and tutorials are written using markdown (the documentation application will convert it all to html, no worries).
Most of the documentation currently references the older (v.0.12.x) API and is dire need of a total rewrite... even simply deleting irrelevant parts will be a help.