Skip to content

Instantly share code, notes, and snippets.

@tomdale
Created February 18, 2012 01:54
Show Gist options
  • Star 12 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save tomdale/1856842 to your computer and use it in GitHub Desktop.
Save tomdale/1856842 to your computer and use it in GitHub Desktop.
Ember documentation TODO

Documentation

TODO

  • API docs

  • How to bootstrap a project

  • Application structure (M/V/C layers and what they're for)

  • Getting started with Ember and Rails

  • Built-in controls

  • How events are handled and bubbled

  • Ember.ArrayController

  • Array observers, propagation and ArrayProxy

  • How the view layer works - 30,000 foot view

  • How to use state managers

  • Bindings and run loop overview

    • Run once
  • Building Ember.js applications (conceptually, what needs to happen?)

  • Debugging

    • Ember.Application and toString
    • {{debugger}}
    • {{log}}
  • Handlebars composition

  • Handlebars helpers

    • paths
    • binding aware
  • View layer lifecycle hooks

  • Others

    • Routing
    • Persistence
      • jQuery.ajax
      • Equivalent of Backbone sync
      • ember-data
    • ember-debug
@patcito
Copy link

patcito commented Feb 18, 2012

It would be great to have ember-data combined with the "Getting started with Ember and Rails" part with a basic CRUD app using ajax and ember-data to send the data.

@jackdempsey
Copy link

@patcito have you seen this? https://github.com/dgeb/ember_data_example might be interesting to you.

@patcito
Copy link

patcito commented Feb 18, 2012

@jackdempsey looks good, I need to hit the refresh link to make new contact numbers show up, not sure if this is on purpose. That being said, it would be great to have something like that included in the default documentation.

@zeppelin
Copy link

I'd love to see an example of using the router and state managers together.

@dgeb
Copy link

dgeb commented Feb 18, 2012

@jackdempsey @patcito - yes, there are definitely some issues with my example app, like the one you mentioned - see https://github.com/dgeb/ember_data_example/issues

I'm trying to keep it updated along with ember-data. Pull requests are welcome :)

@strathmeyer
Copy link

The "View layer lifecycle hooks" section should include an example of how to fade a new element into the page.

@skilesare
Copy link

I'd really like for the authors to consider being as rails-agnostic as possible. It just muddies the waters for people trying to use ember with .net or just straight up web services. You can write web services in rails and you can use ember with web services. One shouldn't have to do much with the other (unless there are some specific hooks that make rails work like magic with ember).

@skilesare
Copy link

Here is the biggest thing to me. I didn't 'get' asp back in the day. One day I read an article about the 'page life cycle' that made everything gell. All of a sudden I was building server controls and it all made sense.

I'd love a 'page lifecycle' for ember. Or rather the event loop. A set happens. Code Runs. A collection of bindings is cross referenced. Observers run. Loop starts over.

@jackdempsey
Copy link

@dgeb totally. i've actually rewritten your example in coffeescript locally, will likely share at some point. want to level up my own knowledge before disseminating the codes :-)

@skilesare maybe i'm not following, but Ember does have a loop. Are you looking for a different kind or didn't realize it?

@skilesare
Copy link

@jackdempsey I just want someone to document it. Maybe with some pictures. See this: http://msdn.microsoft.com/en-us/library/ms178472.aspx I'll be more than happy to do it once I really understand it but I'm not there yet.

@frodsan
Copy link

frodsan commented Feb 22, 2012

Hi guys! Yesterday, i wrote a post about how to contribute to Ember docs :)

@msheakoski
Copy link

When dealing with state managers and/or Rails, it would be helpful if best practices for authenticating a user against the back end server were explained. Perhaps an example where unauthenticated users are presented with only a login form and once authenticated, the rest of the interface appears with their name in the corner and the option to log out.

@johngouf
Copy link

johngouf commented Mar 1, 2012

Hi there, what I would find really useful is a list of available plugins.
For instance, I have recently discovered this: http://ghempton.github.com/ember-layout-example/ which I think is really interesting.

@pangratz
Copy link

pangratz commented Apr 6, 2012

@johngouf there are some useful links in the Ember.js wiki

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment