So you want more documentation?
Have you ever heard of prototype? I’m sure you have, since you’re reading this blog. Many things make this library a weapon of choice for developers all over the world. The way work is done with prototype is simply mind blowing - concise and expressive code, full range of tools for the job just seem to make a dream come true. One day, though, you run into problems - things just don’t work the way they’re supposed to. You open your browser, point it to google and… dark side of prototype reveals itself in its full glory…
No, I’m not trying to sound dramatic, but the fact is that prototype is notoriously famous for the lack of down-to-earth documentation. For javascript ninjas, quick glance over source code should clear all the confusion. For the rest of us, there’s a wonderful place called API reference. This should be your first bookmark on the way to perfection. The sad part is that not everyone understands API reference. People demand easy to follow tutorials, out-of-the-box solutions and lower taxes.
For all of you - lazy bastards - out there, here’s a list of must know resources:
Official documentation
Prototype API reference
Script.aculo.us wiki
News groups:
Google groups, RoR Spinoffs - Number 1 place to look for answers, ask questions, get help quickly. Some really smart folks help hundreds of people with most twisted problems (yes, you’re right, 90% are IE related)
Google groups, Prototype: Core - Once you know prototype’s source code by heart, feel free to join this group to discuss the inner essence of prototype’s magic. Other than that - great place to search for issues that might have already been solved before.
Core developers’ blogs
Tobie Langel
Andrew Dupont
Thomas Fuchs
Justin Palmer
Dan Webb
Not core developers’ blogs (but still very educating)
Matt Foster
Ryan Gahl
Samuel Lebeau
Other resources
Offline documentation
Prototype API
Script.aculo.us Docs
That’s about it.
Did I forget something? Feel free to add more links in comments.
Good luck and happy prototyping…
AntonioCS said:
#I actually know how to use the api page and I have joined the Google groups, RoR Spinoffs mailing list. The problem is that there are really many features which are not explained! At least for this new version. For example from your previous posts, 'Wrap it up!' and 'Proto.Lazy'. They talk about stuff that I couldn't find reference to in the API. I googled it and got nothing. The only way I understood the stuff that was there was with your help :D
So what I am saying is that prototype has lots of powerful stuff, but unless you read the code or someone else tells you about it, the documentation won't help you :(
Dietrich Kappe said:
#See here for another resource on Prototype documentation.
zack said:
#http://www.sergiopereira.com/articles/prototype.js.html
this is my favorite one.
Chris said:
#Prototype is a great library, but the documentation is one reason that I personally chose jQuery instead. Your mileage may vary:
Visual jQuery documentation
Main jQuery page
API browser
Tutorials
Live examples
vectoroc said:
#I've written russian translation of article about PT 1.6 rc0
See http://vectoroc.blogspot.com/2007/09/prototype-160-release-candidate.html
tetris said:
#it's good not to explain, leave the things cryptic and just explore, code or applis are killed when they become too transparent.
php said:
#"People demand easy to follow tutorials, out-of-the-box solutions and lower taxes."
We're not asking for much. If you look at php's documentation (every function has it's own page) they do go super in depth. They just give clear explanations and a line of code using the function. That's all I'm asking for. Also, allow users to comment on the pages, over time we will generate EVERYTHING anyone ever needs to know within the comments, just like php.net