Time to Help with API Docs

[John Resig]

Hey Everyone -

I know you signed up to the list because you wanted to be able to help
document jQuery. In order to make this happen, we need to convert the
old wiki documentation over to the new format.

To kick start everything, I completely converted the Ajax docs over to
the new format:
http://docs.jquery.com/Ajax

(The /Ajax page is a little rough, but it's a start.)

A full guide on writing docs in this format can be found here:
http://docs.jquery.com/How_to_write_API_documentation

Please reply to this email saying which section(s) you're going to tackle.

@Tane, Joern - I could really use your help here.

--John

[Andrey Fedorov]

Hi John, all,

I added Core/length and Core/size to get the hang of this, and had a couple of points/questions:

1. The Core/length entry title has ( )'s added to the end, even though I specified it as a property. Is this a problem with the template?
2. In both Core/length and Core/size, why is it that the left-hand side menu doesn't float next to the content div?
3. Should one be working from the source when writing documentation, is it OK to work from the older documentation without checking against the source? How much code/structural cleanup will happen in 1.2? Is it worth waiting for that before reading the source?

Cheers,
Andrey

[John Resig]

> 1. The Core/length entry title has ( )'s added to the end, even though I
> specified it as a property. Is this a problem with the template?

Fixed.

> 2. In both Core/length and Core/size, why is it that the left-hand side menu
> doesn't float next to the content div?

Fixed.

> 3. Should one be working from the source when writing documentation, is it
> OK to work from the older documentation without checking against the source?
> How much code/structural cleanup will happen in 1.2? Is it worth waiting for
> that before reading the source?

You should be working directly from the existing Wiki source - not
what's in the jQuery source code (that's old at this point, and will
be removed). We'll do more cleaning up after everything is moved to
this new format - but we've gotta get it done first.

What you've done so far is great - keep up the good work!

--John