jQuery Forum

A single, complete table of contents would be useful, as well.

I do not understand why, two years into this project, there is still only a demo that grew into a poor substitute for real documentation.

I'm afraid that your suggestions fall on deaf ears, however, as it is obvious that the JQM team no longer engages with users here.

You can try to do it yourself and submit a pull request on GitHub. Good luck with that, as they seem very resistant to the changes that are obviously needed in the documentation approach. The documentation does slowly get more complete, but the overall organization is severely flawed.

Hi,

The suggestion is not falling on deaf ears. We're in the process of creating an api docs, just like the one for jQuery UI and Core (see http://api.jqueryui.com for an example). It will also have a facility to search terms over the whole api documentation.

Math, if you're interested in contributing, you're more than welcome.

Anne

Hi AG,

You can find all the docs at github.com/jquery :

Is the jQuery Mobile API doc posted online anywhere, or, at this point is it necessary to build it and install locally? It doesn't do anybody any good if it's kept hidden in a corner.

The jQuery API docs are among the best I have ever encountered, which is one of the reasons it is so frustrating that something similar does not exist for JQM. The docs of the two projects are at counterpoints, quality-wise.

jQuery Mobile doesn't actually have much of an API, though, and it's reasonably well-documented in the demo docs. (Though not nicely search-able and discoverable with the jQuery docs.)

One area where documentation is sorely needed is the CSS. It's pretty-much not documented at all. data-attributes have reasonable coverage. I would hope some CSS documentation is included in this effort.

Biggest problem with the current demo/docs is it's structure. It is madness to try to combine a demo with documentation meant for developers. It would be a nice auxiliary piece, offering the ability to see concepts in action. But it's not a reader-friendly format for reference. It is hard to find topics, for one, because there is no centralized table of contents (is spread around multiple pages at various levels of the hierarchy) and no search capability.

What is needed, then, is really not "API documentation", but a "jQuery Mobile Reference".

Hi all -

Oh, and we're planning on doing a pretty deep re-vamp of markup and styles in 1.4 and will definitely document the sytls in detail then.

..............................................
Todd Parker
jQuery Mobile & UI design lead
Partner, Filament Group Inc.

todd@filamentgroup.com

Thanks for this complete answer. I will probably put my hands in code next month to help. Thank you :)

#########################################################
jQuery, jQuery UI, jQuery Mobile and QUnit columinst in French

Thanks for the update, Todd. This is very encouraging.

It's good to have the demo and new docs online, no matter how incomplete, because it allows potential contributors to quickly see where work is needed.

Actually, I've already found some useful information that isn't included in the current docs. (hashchange and throttledresize events. I've see throttledresize mentioned in post, but not a word about it in the current docs.)

(BTW, drop the final "." in the URL for the API docs. It's a typo.)

Is there some kind of a style guide? I don't mean for appearance - it's clear this will be "skinned" later, but for writing?

@watusiware - As far as a styleguide goes, there are very specific XML formats needed for the API docs so let Anne or myself know if you wanted to help out there.