Page 1 of 3 123 LastLast
Results 1 to 10 of 22

Thread: API Docs Update

  1. #1
    Sencha User
    Join Date
    Mar 2007
    Posts
    6

    Default API Docs Update

    Hello Everyone,

    First of all, congrats on the new site and beta release. I downloaded de zip file but noticed that the API docs are still not up to date. Are there plans to synchronize the API docs with the new releases to come?

  2. #2

    Default

    Note: The documentation and samples will not be fully updated until the 1.0 final release.

  3. #3
    Sencha User jay@moduscreate.com's Avatar
    Join Date
    Mar 2007
    Location
    DC Area =)
    Posts
    16,364

    Default

    what's the point of releasing builds if the docs are not updated to reflect additions? :confused:

  4. #4
    Sencha User Jamie Avins's Avatar
    Join Date
    Mar 2007
    Location
    Redwood City, California
    Posts
    3,661

    Default

    Quote Originally Posted by djliquidice View Post
    what's the point of releasing builds if the docs are not updated to reflect additions? :confused:
    Bug fixes and other priorities I'm sure... But I have to agree that the documentation is becoming woefully out of date...

  5. #5
    Sencha User
    Join Date
    Apr 2012
    Location
    Austin, Texas
    Posts
    4

    Default

    We can always stop releasing bug fixes altogether until the documentation is complete if that's your preference. Obviously, the people complaining about documentation have never actually written documentation...

    EDIT: Upon re-reading, that sounded a bit harsh, so let me rephrase. A LOT of work has gone into building this new site, setting up a company structure, writing code, writing new examples, oh yeah, and updating documentation. We have a LOT of stuff to do, and there aren't many people on the team (only Jack and me full-time right now). So please have a little patience with us as we move toward the final release. Most frameworks don't have good documentation at all -- we're just saying that it's not there during alpha/beta. Most people find that to be reasonable.

  6. #6
    Sencha User
    Join Date
    Mar 2007
    Posts
    6

    Default

    Quote Originally Posted by brian.moeskau View Post
    We can always stop releasing bug fixes altogether until the documentation is complete if that's your preference. Obviously, the people complaining about documentation have never actually written documentation...
    Hahaha I

  7. #7
    Ext User schmidetzki's Avatar
    Join Date
    Mar 2007
    Location
    Germany
    Posts
    110

    Default

    Quote Originally Posted by brian.moeskau View Post
    Most frameworks don't have good documentation at all
    That is true, but should not be used a an argument here. The good documentation was one reason to give yui-ext a chance over other js-libs.

    Therefore it is very important to have a documention at last shortly after release.
    In the meantime every one like me must/can read the source code :-)

  8. #8
    Sencha User JeffHowden's Avatar
    Join Date
    Mar 2007
    Location
    Forest Grove, OR
    Posts
    1,038

    Default

    Quote Originally Posted by schmidetzki View Post
    In the meantime every one like me must/can read the source code :-)
    And, by reading the source code, you'll have an even better understanding of how it works than if you'd just referenced something in the docs.
    Jeff Howden
    Ext JS - Support Team Volunteer
    [email protected]

  9. #9
    Ext User
    Join Date
    Mar 2007
    Posts
    49

    Default

    I was wondering if there are plans to allow some user contributed documentation? I was thinking if the documentation had a commenting system similar to Jacks blog. Select users could see the comment bar and leave edits. Then someone from the Ext team could review them for inclusion. I have lots of personal notes about specific functions that I could add. I realize this is not a small project to do in itself but maybe helpful.

  10. #10
    Sencha User jack.slocum's Avatar
    Join Date
    Mar 2007
    Location
    New York, NY
    Posts
    6,956

    Default

    Brant, that is definitely going to happen it's just a matter of when. I have a few ideas for it. The actual commenting code isn't difficult, the most time consuming part would be the additional "online" documentation generator templates that could generate what is needed to make that work. 1 set of templates for the download and one set of templates for "live" docs online.
    Jack Slocum
    Sencha Co-Founder, Ext JS Founder
    Original author of Ext JS 1, 2 & 3.
    Twitter: @jackslocum

Page 1 of 3 123 LastLast

Posting Permissions

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