Ember.js Guides

On the left side of each page in the Guides is a table of contents, organized into sections that can be expanded to show the topics they cover. Both the sections and the topics within each section are ordered from the most basic concepts to the more advanced.

The Guides are intended to contain practical explanations of how to build Ember apps, focusing on the most widely-used features of Ember.js. For exhaustive documentation of every Ember feature and API, see the Ember.js API documentation.

The Guides begin with an explanation of how to get started with Ember, followed by a tutorial on how to build your first Ember app. If you're brand new to Ember, we recommend you start off by following along with these first two sections of the Guides.

While we try to make the Guides as beginner-friendly as we can, we must establish a baseline so that the guides can keep focused on Ember.js functionality. We will try to link to appropriate documentation whenever a concept is introduced.

To make the most out of the guides, you should have a working knowledge of:

• HTML, CSS, JavaScript - the building blocks of web pages. You can find documentation of each of these technologies at the Mozilla Developer Network.
• Promises - the native way to deal with asynchrony in your JavaScript code. See the relevant Mozilla Developer Network section.
• ES2015 modules - you will better understand Ember CLI's project structure and import paths if you are comfortable with ES6 JavaScript Modules.
• ES2015 syntax - Ember CLI comes with Babel.js by default so you can take advantage of newer language features such as arrow functions, template strings, destructuring, and more. You can check the Babel.js documentation or read Understanding ECMAScript 6 online.

Typos, missing words, code samples with errors are all considered documentation bugs. If you spot one of them, or want to otherwise improve the existing guides, we are happy to help you help us!

Some of the more common ways to report a problem with the guides are:

• Using the pencil icon on the top-right of each guide page
• Opening an issue/pull request to the GitHub repository

Clicking the pencil icon will bring you to GitHub's editor for that guide so you can edit right away, using the Markdown markup language. This is the fastest way to correct a typo, a missing word, or an error in a code sample.

If you wish to make a more significant contribution be sure to check our issue tracker to see if your issue is already being addressed. If you don't find an active issue, open a new one.

If you have any styling questions, or about the contributing process you can check out our contributing guide. If your question persists, reach us in the #dev-ember-learning channel on the Ember Community Discord.

Good luck!