The Great jQuery Document Drive

[Tane Piper]

Hey folks,

Now that the basecamp is up for jQuery UI, John mentioned using it for
other stuff as well like core and docs, so reading over a few emails
on the various lists, and reading comments in IRC I'd like to propose
The Great jQuery Document Drive.

The premise is pretty simple. We want ONE core area for all jQuery
documentation - Core, UI, Official Plugins and Unofficial too.

Part 1 of the task is a rebirth of the current Core and UI docs. Each
person who joins the drive is given 1 section, and 1 section only to
deal with. It's this persons responsibility to go through that
section and update every function to the current 1.2.1 core, as well
as adding examples. Using the basecamp, this person tracks their
progress and once they hit 100%, the move on to another unassigned
section.

Once this is done, we use the Wiki2XML plugin for mediawiki that was
suggested and output the core and UI docs.

Phase 2 is Official Plugins. First of all, each plugin needs to be
checked to see it's 1.2 compatable. If it is, then work begins on
adding it's documentation to the Wiki. Again one person is assigned a
plugin and works soley on it.

Then the XML docs for these are generated.

Then Phase 3, the most ambicious phase - to try and document as many
1.2.1-compatible plugins as possible. The first choice would be to
contact the plugin author and get them to do it, but failing that,
again each team member is assigned a plugin to disect and document.

I think phase 1 & 2 would be compleatable by the end of the year at
the very lastest, but of course it requires commitment from a few core
people.

If anyone wants to chip in here, feel free - comments, concerns, etc

--
Tane Piper
http://digitalspaghetti.me.uk

This email is: [ ] blogable [ x ] ask first [ ] private

[Jörn Zaefferer]

A few questions come to my mind to:

- Isn't jQuery Core and UI already (mostly) done? What do you expect
to improve/add?
- Naming schemes: Currently the Core API is at top level, while UI
stuff is under UI, where should plugins go, whether official or not?
Plugins/?
- Should links to UI/Plugins API be added to the front page?

Actually I've started moving the documentation for my treeview plugin:
http://docs.jquery.com/Plugins/Treeview
I haven't released that yet, so there is no trouble yet moving that
page.

-- Jörn

[Benjamin Sterling]

Tane,
I'm in, just tell me when and where.

On Sep 27, 3:16 pm, "Tane Piper" <digitalspaghe...@googlemail.com>
wrote:

> Tane Piperhttp://digitalspaghetti.me.uk

[Tane Piper]

Jorn,

Well I suppose with Core and UI, what I mean is go over them in great
details, looking for any typos and making sure absolutely everything
is up to date.

I also think the UI should go on the front page, but only after the
next release, once it's all been updated.

And I think yea, /Plugins would be a good place to put both official
and unofficial plugins, sorted in alphabetical order.

[John Resig]

On 9/28/07, Jörn Zaefferer <joern.z...@googlemail.com> wrote:
>

> A few questions come to my mind to:
>
> - Isn't jQuery Core and UI already (mostly) done? What do you expect
> to improve/add?

We need runnable demos for everything in jQuery. I think we
demonstrated this pretty well with the UI release, but we need to
improve on this and make at least one for everything in jQuery.

> - Naming schemes: Currently the Core API is at top level, while UI
> stuff is under UI, where should plugins go, whether official or not?
> Plugins/?

Correct, for example:
http://docs.jquery.com/Plugins/Calendar

> - Should links to UI/Plugins API be added to the front page?

I added references to UI on the front page and in the side bar - I'm
not sure what the best way to reference the Plugins docs should be.

--John

[polyrhythmic]

I'm in, however I can help.

Charles
@doublerebel.com

On Sep 28, 9:20 am, "John Resig" <jere...@gmail.com> wrote: