#147 ✓fixed_in_branch
David Reese

Minimize vertical spacing in header in api docs

Reported by David Reese | February 19th, 2010 @ 05:21 PM

Summary: The vertical spacing above the Prototype header in the jsdoc should be reduced.

I was just using the jQuery API docs (ack, sorry, it's a client project), and I was frustrated because every time I changed functions, I had to scroll down to get actual content. The top header takes 230px, and it's almost 400 pixels before you get an actual description of the function! That's half my macbook! Not to mention the fact that it's written like the python docs (ie, not for normal-functioning social brains).

The prototype jsdoc site a ton better, in a large part because the left frame stays put, so browsing is a lot easier. And it's freaking beautiful compared to the jQuery site.

BUT, is that vertical whitespace in the header and the large 'Prototype' really necessary? I like whitespace as much as the next guy, but this is documentation. It doesn't seem to serve a function except to exercise my scroll-finger.

Comments and changes to this ticket

  • Nathan L Smith

    Nathan L Smith February 19th, 2010 @ 05:38 PM

    Good point. It might be better if the prototype logo were floated right without the grey bar at all, to let the docs start at the top of the page.

    +1

  • Dan Dean

    Dan Dean February 19th, 2010 @ 06:49 PM

    We're already working on similar issues. This should be addressed relatively soon.

    Thanks for the input!

  • Dan Dean

    Dan Dean February 26th, 2010 @ 12:33 AM

    • State changed from “new” to “fixed_in_branch”

    This is fixed in the latest doc branch and will make it's way into the master branch soon.

    You may build the documentation branch of Prototype from source or wait until our next official release to benefit from it.

    The documentation branch is here:

    http://github.com/samleb/prototype/tree/documentation

    Note that this may not contain the most up to date source code, but it will have the most up to date documentation.

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

Pages