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 help needed. #19

Open
boazsegev opened this Issue Aug 5, 2016 · 0 comments

Comments

Projects
None yet
1 participant
@boazsegev
Copy link
Owner

boazsegev commented Aug 5, 2016

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.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.