Documentation

Web Feature List

From jQuery JavaScript Library

Jump to: navigation, search

Plugins Area

  • All plugins must be imported from the current wiki (luckily, I already did all the hard work of giving everything a consistent structure)
  • It would be nice if the plugins area was more "wiki-like", in that other users could make minor changes to a particular plugin.
    • Barring that, having a per-plugin forum area would work nicely
  • A way to rate and/or favorite plugins would be great
  • As would the ability to write reviews (different from a discussion area) (example)
  • RSS Change-log/update feed
  • Categorization (A plugin can be in multiple categories - I like how Drupal does it in this case)
  • Each plugin should have the following extracted from its documentation:
    • Name
    • Author
    • Description
    • Version (If no version exists, we should give it one, like 0.1)
    • Browsers tested on
      • indicate pass/fail/untested on individual browsers (IE 6/7, FF 2, Safari 2, Opera 9)
    • Dependencies
      • Minimum/Maximum version of jQuery
      • Each Plugin, and min/max version
    • Stability
      • Level of stability (new, alpha, beta, stable, official)
      • Level of documentation (none, basic, full)
      • Forward compatibility (unlikely, possible, likely)
    • License(s)
  • There should be links to the following
    • API
      • Will be auto-generated from the inline docs
    • Demo page(s)
    • Tutorial(s)
    • Download URL
      • Code + Docs
      • Code + Docs + Dependencies
    • SVN repository, where applicable (not everything will, necessarily, be in SVN)
      • We can opt to just link to Trac for this, thankfully

Forum Area

  • We need to import all of the mailing lists and users into it.
  • If there's a subscription model for the forums (get all posts by email, and optionally all replies too, within a forum) then we can end the mailing list and just move everyone over to this.