[ 3 posts ]

Murray Macchio

YUI Contributor

  • Username: murdog05
  • Joined: Fri Jan 23, 2009 4:24 am
  • Posts: 25
  • GitHub: murdog05
  • Gists: murdog05
  • Offline
  • Profile

Gallery component Documentation

Post Posted: Sat Jun 19, 2010 6:07 am
+0-
Just a thought here, but having gone through the gallery, I have noticed that some components are documented pretty thoroughly, they provide examples, and documentation explaining the module (in classic YUI style), and some have very little documentation.

What does everyone think of a designation for those components that are documented well? Something similar to featured, perhaps a stamp of "YUI Approved documentation". One of the things I that I believe makes YUI especially great is the documentation and examples that it provides to make using each piece of the library easy. I think if this was encouraged in the gallery it would make life a lot easier on everyone using the gallery and really put a spot light on those modules that have the best documentation.

Another post that touches on a related topic is this: viewtopic.php?f=101&t=3908

Feel free to correct me if I am wrong, but I feel that at least half of the work in creating a re-usable component, is providing the documentation to go with it.

Murray Macchio

YUI Contributor

  • Username: murdog05
  • Joined: Fri Jan 23, 2009 4:24 am
  • Posts: 25
  • GitHub: murdog05
  • Gists: murdog05
  • Offline
  • Profile

Re: Gallery component Documentation

Post Posted: Sat Jun 19, 2010 6:09 am
+0-
Just one quick thought to follow up,

The Accordion widget is a good example of proper documentation.

http://yuilibrary.com/gallery/show/accordion

Matt Parker

YUI Contributor

  • Username: mattatlamplight
  • Joined: Mon Apr 20, 2009 12:03 pm
  • Posts: 465
  • Location: London UK
  • GitHub: mattparker
  • Gists: mattparker
  • Offline
  • Profile

Re: Gallery component Documentation

Post Posted: Sat Jun 19, 2010 7:46 am
+0-
Hi,

There's some in this discussion related to this too:

viewtopic.php?f=18&t=3976

Matt
  [ 3 posts ]
Display posts from previous:  Sort by  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum