#182 new

General API Documentation

Reported by Sander | June 22nd, 2011 @ 12:57 PM


I have a question about the API Documentation that is generally available on the website of Prototype (and just a little more).

The 'new' style documentation refers to the 1.7 documentation while the old one is (good as it is!) still available which Google is still indexing and I access it via my bookmarks. I try to use the new documentation now and then but for some reason I don't think it is nice to use. Also other developers tend to use the old one, over the new one.

I really believe in the Prototype library - but I also notice that the jQuery (for example) community is growing larger and larger and less people seem to be interested in Prototype. It would be great if Prototype would become more popular, so that the community grows, which hopefully supports development as well. I think this can be achieved by adding a Forum on the website, that is easily accessibly. Of course I use the Mailing List as well, but a Forum would be an easy way to access. This is however not the most important addition I think.

The amount of information in the Prototype API Documentation could use a little more.. documentation. This way more people can see how the full power and potential of Prototype can be unleashed and why this is such an interesting library.

A good example of what I believe that is a good manual, is the PHP manual. A semi-fixed format where you can find all the required information to quickly use the specific class/function. Especially the Examples are very handy. I know the Prototype documentation has examples, but for this new function Element.Offset only a little amount of documentation is present - actually I don't know how to use it (yet).

What are the plans for the documentation? Would it be possible to add examples myself? And also.. how does the Prototype team see the future regarding a community?

If this sounds like a cry for help, well.. maybe it is. But not 100% for me, but for the entire community!


Please Sign in or create a free account to add a new ticket.

With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.

New-ticket Create new ticket

Create your profile

Help contribute to this project by taking a few moments to create your personal profile. Create your profile ยป

Shared Ticket Bins

People watching this ticket