New category "Documentation"?


#1

What about creating a forum category “Ember Documentation”?

I would like to have a place for anyone to ask questions stemming from Ember’s API documentation and guide, including myself :slight_smile: . This could also help identify potential pitfalls in the documentation and create an additional feedback loop for documentation evolution.


#2

Here is an example documentation suggestion:

Ember’s documentation provides sample code, for instance the JavaScript sample code in the “Managing Asynchrony” section. The visualization of the source code unfortunately is cropped on my computer. Providing a horizontal scroll bar would allow to see the full source code.

This cropping also happens with images.


#3

Here is another example documentation suggestion:

I just noticed that http://emberjs.com/guides/routing/defining-your-routes/ doesn’t mention App.ApplicationController. In my opinion, knowing about the ApplicationController is useful for understanding Ember.

(… App.ApplicationController != App.IndexController)

Here is a jsFiddle that uses both ApplicationControllers and IndexController: http://jsfiddle.net/Abdull/vwJEG/


#4

Does seem like a good idea for a discuss category. Probably would be good if the discussions naturally resolved into actionable steps to improve documentation.

Perhaps there should be an onus on creator of specific threads in this category to synthesize the thread’s contents into a pull request to improve docs.

The challenge I suppose is unintentionally creating alternate form of documentation. Definitely want that feedback to make its way back into the ember website.


#5

Seems like a reasonable idea but I am not seeing too many documentation topics via the search function. There are but a handful.

Here’s the current category list:
http://discuss.emberjs.com/categories

Here’s a list of all recent “uncategorized” topics:
http://discuss.emberjs.com/category/uncategorized/

I’d be interested in any newly proposed categories that could apply to say 20% of the topics in that list.