On 09/08/06, John Resig <[EMAIL PROTECTED]> wrote:
> Hi Everyone -
>
> I've been busy the past couple nights working on the new
> documentation. You can see it being generated on the fly here (this is
> also in SVN, rev 172 - look in the docs folder):
> http://john.jquery.com/jquery/docs/
>
> It's still very basic, pretty crude - and missing a couple functions
> (including the Ajax module) but it's getting there. The big feature
> that I'm going to work in next is going to be categorization by
> category - this way you can find all the methods related to DOM
> traversing (for example) right on one page.
>
> Any/all feedback is appreciated - let me know if you spot any specific
> bugs - and especially bugs with  the actual docs themselves.
>
> Some tech details:
> - The docs are (currently) written inline inside of the jQuery
> javascript files using a pseudo-JSDoc-like way of writingi docs.
> - This is parsed out with a simple Perl program and converted to two JSON 
> files.
> - These files are then loaded into the docs html page that you see.
> - I use a re-written version of Klaus' pager plugin and an un-touched
> copy Sam's tooltip code to help make things run smoothly.
> - I also use strictly JSON/JSONP/JSONT to get the job done - no AJAX needed 
> :-)
>
> All feedback is appreciated!
>
> --John
>

Looking good so far. Categorization by category - genius ;)

As said before, 'I' could be hard to click, so perhaps use a monospace
font for the navigation? Search would be useful as well.

I never tested the tooltip in svn, but its good that it works (I
thought it would work as it only uses basic jQuery and DOM functions).

_______________________________________________
jQuery mailing list
[email protected]
http://jquery.com/discuss/

Reply via email to