Doc Center Updates: User Commenting and More http://www.sencha.com/blog/commenting-on-documentation Improving the documentation experience for our customers is a top priority at Sencha. One often requested feature is the ability for our customers to add comments directly to the class documentation. Today we’re happy to announce the availability of this functionality in our latest documentation update. en-us nick@extjs.com Copyright 2011 2011-10-21T15:00:15+00:00 Comment by abc naslhkjlkakjdsklko irjipruiqejfiqwf qjeipfj jpifjfj jfij fklwjfj naslhkjlkakjdsklko irjipruiqejfiqwf qjeipfj jpifjfj jfij fklwjfj

]]> Tue, 01 Nov 2011 14:35 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28884#date:14:35 Comment by Ed Spencer @Anselm that’s great, we really appreciate the feedback. We’ll keep doing that @Anselm that’s great, we really appreciate the feedback. We’ll keep doing that

]]> Sun, 30 Oct 2011 03:29 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28787#date:03:29 Comment by Anselm McClain Wanted to say a special thanks for updating the docs on the older frameworks to be duckified.  Much appreciated as I’m in those daily and the new format is much more efficient. Wanted to say a special thanks for updating the docs on the older frameworks to be duckified.  Much appreciated as I’m in those daily and the new format is much more efficient.

]]> Fri, 28 Oct 2011 21:51 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28732#date:21:51 Comment by Kevin Prince Very Nice. I also really liked the changes to ExtDesigner. Now I want JSDuck in Designer so I won’t have to update generated code. Very Nice. I also really liked the changes to ExtDesigner. Now I want JSDuck in Designer so I won’t have to update generated code.

]]> Wed, 26 Oct 2011 13:58 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28658#date:13:58 Comment by Rene Saarsoo @Maurice: The comments will certainly be monitored and cleaned up. It’s already being done. @Nom4d3: Thanks. Should get fixed soon. @Shaoning: The source is at https://github.com/senchalabs/jsduck @Maurice: The comments will certainly be monitored and cleaned up. It’s already being done.

@Nom4d3: Thanks. Should get fixed soon.

@Shaoning: The source is at https://github.com/senchalabs/jsduck

]]> Tue, 25 Oct 2011 16:49 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28637#date:16:49 Comment by Shaoning Zeng where can i can find source code? Only app.js in built version i can see. where can i can find source code? Only app.js in built version i can see.

]]> Tue, 25 Oct 2011 01:47 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28601#date:01:47 Comment by Nom4d3 Is not working on Opera. It stays on the loading screen forever. Is not working on Opera. It stays on the loading screen forever.

]]> Mon, 24 Oct 2011 15:33 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28580#date:15:33 Comment by Christian Dube @Conor no hard feelings here, though I should let you know that this comment was from the “beta”. No idea why it wasn’t removed, as I posted several other comments that were removed before going Live. @Sencha most impressive. This is another great feature that is well implemented. @Conor no hard feelings here, though I should let you know that this comment was from the “beta”. No idea why it wasn’t removed, as I posted several other comments that were removed before going Live.

@Sencha most impressive. This is another great feature that is well implemented.

]]> Mon, 24 Oct 2011 11:01 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28578#date:11:01 Comment by Maurice Will someone verify and check the comments?  Just like with php.net?  I’ve stumpled upon some comments/messages that only said ‘awesome’ (and some reactions to that). IMHO not very helpful! Just like some questions (how do I do…) We have several forums for that… I hope the docs in the packages don’t have this feature So, it CAN be helpful if the content is right. Otherwise: more rubbish and no-one will use it! Thanks! Will someone verify and check the comments?  Just like with php.net?  I’ve stumpled upon some comments/messages that only said ‘awesome’ (and some reactions to that). IMHO not very helpful!
Just like some questions (how do I do…)
We have several forums for that…
I hope the docs in the packages don’t have this feature wink

So, it CAN be helpful if the content is right. Otherwise: more rubbish and no-one will use it!

Thanks!

]]> Mon, 24 Oct 2011 08:37 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28575#date:08:37 Comment by Ed Spencer @Gevik let’s connect after the craziness of SenchaCon is out of the way (we can meet up if you’re coming) @Gevik let’s connect after the craziness of SenchaCon is out of the way (we can meet up if you’re coming) smile

]]> Sun, 23 Oct 2011 05:09 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28562#date:05:09 Comment by Gevik @Ed, Could you please clarify (or at least change) the doc on the “Abstract” classes. If these classes are private and we cannot rely on their existence, then how come the components which inherited from these classes still show config options which belong to their abstract parents! Honestly, as I see it, the abstract classes are here to stay, and will not change as rapidly as stated in the docs. Not being able to rely on the existence of the Ext.AbstractComponent and its config options for example, will make life for us component developers much harder. Don’t you think? @Ed,

Could you please clarify (or at least change) the doc on the “Abstract” classes. If these classes are private and we cannot rely on their existence, then how come the components which inherited from these classes still show config options which belong to their abstract parents!

Honestly, as I see it, the abstract classes are here to stay, and will not change as rapidly as stated in the docs.

Not being able to rely on the existence of the Ext.AbstractComponent and its config options for example, will make life for us component developers much harder. Don’t you think?

]]> Sat, 22 Oct 2011 20:23 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28559#date:20:23 Comment by Ed Spencer @Jay you’d be surprised @Jay you’d be surprised wink

]]> Sat, 22 Oct 2011 03:29 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28553#date:03:29 Comment by JWL You guys are awesome! You guys are awesome!

]]> Sat, 22 Oct 2011 01:52 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28552#date:01:52 Comment by Jay Garcia @Ed, crap dude.  How much better can the docs app get? :D @Ed, crap dude.  How much better can the docs app get? :D

]]> Sat, 22 Oct 2011 00:33 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28549#date:00:33 Comment by Les Good stuff Good stuff smile

]]> Fri, 21 Oct 2011 22:49 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28547#date:22:49 Comment by interfasys Great news! Adobe has had it for years and it’s very helpful to add code or warn about errors, etc. Great news! Adobe has had it for years and it’s very helpful to add code or warn about errors, etc. smile

]]> Fri, 21 Oct 2011 22:45 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28546#date:22:45 Comment by Ed Spencer Thanks @Vlatko and @Jan-Simon We are, of course, just getting started. There’s a good deal of stuff in the pipeline that will take the docs to the next level Thanks @Vlatko and @Jan-Simon smile We are, of course, just getting started. There’s a good deal of stuff in the pipeline that will take the docs to the next level

]]> Fri, 21 Oct 2011 22:39 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28545#date:22:39 Comment by Henry Sencha continues to set the bar higher!  This is fantastic!  While I see Condor’s perspective, this happens when commenting is added to any API.  But as the issues are addressed, richer and fuller examples emerge.  I’ve been a part of this community too long to know that there’s a wealth of knowledge waiting for the right medium.  Yes, we have the forums, but having the context of the class/method now is going to help us/me a lot. Congrats to the docs team!  Keep up the great work. Sencha continues to set the bar higher!  This is fantastic!  While I see Condor’s perspective, this happens when commenting is added to any API.  But as the issues are addressed, richer and fuller examples emerge.  I’ve been a part of this community too long to know that there’s a wealth of knowledge waiting for the right medium.  Yes, we have the forums, but having the context of the class/method now is going to help us/me a lot.

Congrats to the docs team!  Keep up the great work.

]]> Fri, 21 Oct 2011 22:25 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28544#date:22:25 Comment by Jan-Simon Winkelmann Very nice job, the docs have really come a long way since the release of 4.0 and I’m really happy on how they’re working and performing now. Great work guys! Very nice job, the docs have really come a long way since the release of 4.0 and I’m really happy on how they’re working and performing now. Great work guys!

]]> Fri, 21 Oct 2011 22:13 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28543#date:22:13 Comment by Vlatko Koudela As from now I can say that you have the best documentation system! I’ll try to contribute as much as I can. As from now I can say that you have the best documentation system! I’ll try to contribute as much as I can.

]]> Fri, 21 Oct 2011 21:58 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28542#date:21:58 Comment by Jay Robinson Nick, fantastic job on the Documentation app! People are really going to get some use out of these helpful comments. It will help *us* to find the weak areas of the Docs as well! Nick, fantastic job on the Documentation app! People are really going to get some use out of these helpful comments. It will help *us* to find the weak areas of the Docs as well!

]]> Fri, 21 Oct 2011 21:11 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28541#date:21:11 Comment by Loiane Great Job! Nice feature! Great Job! Nice feature! smile

]]> Fri, 21 Oct 2011 20:45 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28540#date:20:45 Comment by Conor Armstrong One thing I’ve notice though is people are using the comments to indicate improvements they would like to see to the base code - eg Ext.grid.Panel, method removeListener .  By way of example (not picking on him or anything) @ChristianD comments that he would like a certain return value. If this type of comment continues, we are going to see lots of somewhat unhelpful comments instead of the more useful code snippets, possible gotchas and tips that are millions of times more useful.  If the Action combo included say “Proposed improvement” as an option, these type of comments could be much more easily filtered. One thing I’ve notice though is people are using the comments to indicate improvements they would like to see to the base code - eg Ext.grid.Panel, method removeListener .  By way of example (not picking on him or anything) @ChristianD comments that he would like a certain return value.

If this type of comment continues, we are going to see lots of somewhat unhelpful comments instead of the more useful code snippets, possible gotchas and tips that are millions of times more useful.  If the Action combo included say “Proposed improvement” as an option, these type of comments could be much more easily filtered.

]]> Fri, 21 Oct 2011 20:20 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28539#date:20:20 Comment by Conor Armstrong Fantastic idea.  Really like this one.  This is one of the thing that is great about PHP’s documentation.  Great to see it here in ExtJs & ST Fantastic idea.  Really like this one.  This is one of the thing that is great about PHP’s documentation.  Great to see it here in ExtJs & ST

]]> Fri, 21 Oct 2011 20:14 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28538#date:20:14 Comment by David Davis Ahh, clicking sign in should probably open and focus the sign in area at the top or have a inline sign in Ahh, clicking sign in should probably open and focus the sign in area at the top or have a inline sign in

]]> Fri, 21 Oct 2011 19:30 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28535#date:19:30 Comment by David Davis Great job guys! Found two issues: http://docs.sencha.com/ext-js/4-0/#!/api/Ext shows 0 comments, but there are at least 2 When I click sign in, it says no such user Great job guys!

Found two issues:
http://docs.sencha.com/ext-js/4-0/#!/api/Ext shows 0 comments, but there are at least 2
When I click sign in, it says no such user

]]> Fri, 21 Oct 2011 19:28 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28534#date:19:28 Comment by Jay Garcia Great job Nick! Great job Nick!

]]> Fri, 21 Oct 2011 18:17 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28530#date:18:17 Comment by Mattis The commenting system sounds really useful! The commenting system sounds really useful!

]]> Fri, 21 Oct 2011 18:01 GMT http://www.sencha.com/blog//commenting-on-documentation#id:28529#date:18:01