How to help improve Pallet's documentation
Thank you for your interest in helping Pallet out!
Pallet started development in 2010 and we have been working very hard at it for the last two years. Unfortunately, although the code has been getting better and better, the documentation has been chronically left behind.
In late 2011 we started an effort to put Pallet’s documentation up to par with the code. This site that you are now visiting, and this page that you’re reading, are just some of the first steps towards this goal.
Did you find a broken link, or a broken example, something is clear as mud or even a full area of documentation missing? If you did, you can help us greatly in fixing it, and here is how:
I don’t have much time, how can I help?
The easiest way to help is by reporting an issue in our issue tracker.
To do this, click here to create a new issue in our documentation issue tracker.
Please provide a concise title e.g. “The AWS example in /doc/example/create-node doesn’t work with Pallet 0.6.5”, and add as much information in the description as possible, especially the page or pages affected and if you have the time, a possible solution or indication of how the solution would look like.
If possible, select the tag to the right of the page to indicate the type of error (error, missing, unclear, etc.) and the area of the website where it is (documentation, reference, api, etc.)
Really, I don’t have the time :(
Send a tweet to @palletops then!
I can’t stand broken documentation! I feel an urge to right this wrong.
Ah then! Thank you!
Wait patiently and Karma will arrive your way!