Initial commit of Rec Room docs in Markdown format #45
Conversation
- Will eventually move docs to MDN App Center - Quick Start, but we need them on GitHub as well.
|
|
||
| Firefox OS apps are built using the Web. That means that all that you have learned about HTML, CSS and Javascript applies to developing apps for the Firefox OS platform. Mozilla, inconjunction with other browser vendors and the W3C has developed a number of [WebAPIs](https://wiki.mozilla.org/WebAPI) to provide access to key mobile phone systems and services. We will cover these APIs later in the documentation. | ||
|
|
||
| Rec Room uses Ember.js as the framework to build your app’s controllers, models, and views. While you don’t need to know Ember.js (our documentation will walk you through the basics you’ll need), some previous knowledge would be useful. You can always refer to the[ Ember.js docs](http://emberjs.com/api/) if you need additional information. |
There was a problem hiding this comment.
Might want to link to a good write-up explaining MVC architecture? Would be useful for beginner developers who haven't heard of the concept, and not wildly obtrusive for users that are already familiar.
There was a problem hiding this comment.
I'm thinking Appendix 2 will contain that. In the google docs I copied and pasted chunks that are important concepts from the Ember guides, but it needs to be re-written.
There was a problem hiding this comment.
Here's my suggested change:
Rec Room uses Ember.js as the framework to build your app’s controllers, models, and views. While you don’t need to know Ember.js (our documentation will walk you through the basics you’ll need), some previous knowledge would be useful. You can always refer to the excellent Ember.js guides. They do a good job explaining the structure of Ember apps, especially in relation to the MVC (Model View Controller) design pattern.
We also provide a brief introduction to important Ember concepts in [Appendix 2: A Brief Introduction to Ember](A2 - A Brief Introduction to Ember.md).
| } | ||
| ``` | ||
|
|
||
| Further documentation can be found on [MDN - App Manifest](https://developer.mozilla.org/en-US/Apps/Build/Manifest). Apps that require access to system APIs like the Camera, Contacts, etc. must specify the permissions required in manifest.webapp. [Hosted Apps and Privileged Apps](https://developer.mozilla.org/en-US/Apps/Build/App_permissions) have different levels of access to certain APIs. [Packaged apps](https://developer.mozilla.org/en-US/Marketplace/Publishing/Packaged_apps) can be distributed through the Firefox Marketplace. |
There was a problem hiding this comment.
Feels a little odd to be throwing around info and links about Hosted/Privileged/Packaged Apps in this paragraph before the section explaining that there are different types of applications. Not sure how to re-word/organize this yet but will come back to this and PR something.
There was a problem hiding this comment.
Good point, I put Types of Applications before the Manifest File section
Format ordered list & fix chown typo
Format grunt serve command
Formatting and grammar tweaks
Conflicts: docs-guide/02 - Create Your First Project.md
Add rough draft of chapter 8
Add rough draft for Chapter 9
| localforage.setItem('key', 'value', callbackYouDefine); | ||
|
|
||
| // Get an item and log the value to the console | ||
| localforage.getItem('key', function(value) { |
There was a problem hiding this comment.
localForage 1.0 annoying switched to an error-first style callback, so this should actually be: localforage.getItem('key', function(err, value) {
we need them on GitHub as well.