Results 1 to 6 of 6

Thread: Wiki?

  1. #1
    Sencha User
    Join Date
    Sep 2012
    Posts
    13
    Vote Rating
    2
      -1  

    Default Wiki?

    Has there ever been a discussion on creating a Wiki for Sencha API? Couldn't be any worse than the currently outdated and inaccurate docs.

  2. #2
    Sencha - Sr Software Engineer mitchellsimoens's Avatar
    Join Date
    Mar 2007
    Location
    Gainesville, FL
    Posts
    39,318
    Vote Rating
    1293
      0  

    Default

    Quote Originally Posted by andyjv View Post
    Has there ever been a discussion on creating a Wiki for Sencha API?
    The issue I see is that we then have to have someone approve and maintain quality control. You may do great at it but someone else may just provide not enough or plain wrong info. It's something that has been floated around so it's not being turned down just logistics that has to be figured out for building and maintaining.

    Quote Originally Posted by andyjv View Post
    Couldn't be any worse than the currently outdated and inaccurate docs.
    Wouldn't say this is true but my own personal opinion.
    Mitchell Simoens @LikelyMitch
    Sencha Inc, Senior Software Engineer
    ________________
    Learn BBCode and use it!

    Check out my GitHub, lots of nice things for Ext JS 4 and Sencha Touch 2
    https://github.com/mitchellsimoens

    Think my support is good? Get more personalized support via a support subscription. https://www.sencha.com/store/

    Need more help with your app? Hire Sencha Services services@sencha.com

    Want to learn Sencha Touch 2? Check out Sencha Touch in Action that is in print!

    When posting code, please use BBCode's CODE tags.

  3. #3
    Sencha User
    Join Date
    Sep 2012
    Posts
    13
    Vote Rating
    2
      0  

    Default

    Well you can update the docs with or without community help. Most of the common components already have plenty of comments that add to the documentation.)

  4. #4
    Sencha User
    Join Date
    Sep 2012
    Posts
    13
    Vote Rating
    2
      0  

    Default

    Every day I come across something like this, which is why there really needs to be a wiki:

    http://docs.sencha.com/touch/2-0/#!/...nePickerConfig

  5. #5
    Sencha User
    Join Date
    Sep 2012
    Posts
    13
    Vote Rating
    2
      0  

    Default

    I'm surprised there isn't more intrest in a Wiki.

    Really you can just look through http://docs.sencha.com/touch/2-0/#!/comment to see many cases of corrections and disappointment in the current docs.

  6. #6
    Sencha User
    Join Date
    Dec 2009
    Location
    Enschede, The Netherlands
    Posts
    327
    Vote Rating
    14
      1  

    Default

    As a general rule: duplication is the devil. Whenever you start duplicating information to multiple sources it is guaranteed to start and bite you in the ass at some point.

    I have no experience (yet) with the Touch docs, but the ExtJS API docs are very well done in my opinion. Giving the extremely difficult context of the various browsers, the speed at wich both the web and Sencha are moving I find the docs astonishing good.

    I believe your effort would be much better spent by providing suggestions to the docs. I have seen "bugreports" for the documentation being taken seriously and I have seen responses to inline comments leading to better documentation. In the end I believe it will be better if you comment in the docs, posts improvement suggestions on the forum or maybe even provide a patch every now and than that can be examind by a Sencha dude and merged into the source documentation.
    Last edited by flanders; 12 Dec 2012 at 12:34 AM. Reason: it should be spent - I think...

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •