docs(afs): README and links

Author: davideast

README.md

@@ -55,11 +55,24 @@ If you want to get started quickly on building with AngularFire2, check out our
 5 step developer guide that will teach you everything you need to know to be 
 productive with AngularFire2.
 
-1. [Installation & Setup](docs/1-install-and-setup.md)
-2. [Retrieving data as objects - FirebaseObjectObservable](docs/2-retrieving-data-as-objects.md)
-3. [Retrieving data as lists - FirebaseListObservable](docs/3-retrieving-data-as-lists.md)
-4. [Querying lists](docs/4-querying-lists.md)
-5. [User Authentication - FirebaseAuthentication](docs/5-user-authentication.md)
-6. [Using AngularFire2 with Ionic 2](docs/Auth-with-Ionic2.md)
-7. [Using AngularFire2 with Ionic 3 and Angular 4](docs/Auth-with-Ionic3-Angular4.md)
-8. [Deploying AngularFire2 to FirebaseHosting](docs/7-deploying-angularfire-to-firebase.md)
+## Getting started
+[Installation & Setup](docs/1-install-and-setup.md)
+
+## AngularFirestore
+[Using collections](docs/firestore/collections.md)
+[Using documents](docs/firestore/documents.md)
+
+## AngularFireAuth
+[User Authentication](docs/5-user-authentication.md)
+
+## AngularFireDatabase
+[Retrieving data as objects](docs/2-retrieving-data-as-objects.md)
+[Retrieving data as lists](docs/3-retrieving-data-as-lists.md)
+[Querying lists](docs/4-querying-lists.md)
+
+## Ionic
+[Using AngularFire2 with Ionic 2](docs/Auth-with-Ionic2.md)
+[Using AngularFire2 with Ionic 3 and Angular 4](docs/Auth-with-Ionic3-Angular4.md)
+
+## Deploying to Firebase Hosting
+[Deploying AngularFire to Firebase Hosting](docs/7-deploying-angularfire-to-firebase.md)

docs/1-install-and-setup.md

@@ -118,6 +118,7 @@ export class AppModule {}
 ### 6. Setup individual @NgModules
 
 After adding the AngularFireModule you also need to add modules for the individual @NgModules that your application needs.
+ - AngularFirestoreModule
  - AngularFireAuthModule
  - AngularFireDatabaseModule
  - AngularFireStorageModule (Future release)
@@ -132,15 +133,15 @@ import { BrowserModule } from '@angular/platform-browser';
 import { NgModule } from '@angular/core';
 import { AppComponent } from './app.component';
 import { AngularFireModule } from 'angularfire2';
-import { AngularFireDatabaseModule } from 'angularfire2/database';
+import { AngularFirestoreModule } from 'angularfire2/firestore';
 import { AngularFireAuthModule } from 'angularfire2/auth';
 import { environment } from '../environments/environment';
 
 @NgModule({
   imports: [
     BrowserModule,
     AngularFireModule.initializeApp(environment.firebase, 'my-app-name'), // imports firebase/app needed for everything
-    AngularFireDatabaseModule, // imports firebase/database, only needed for database features
+    AngularFirestoreModule, // imports firebase/firestore, only needed for database features
     AngularFireAuthModule, // imports firebase/auth, only needed for auth features
   ],
   declarations: [ AppComponent ],
@@ -150,21 +151,21 @@ export class AppModule {}
 
 ```
 
-### 7. Inject AngularFireDatabase
+### 7. Inject AngularFirestore
 
 Open `/src/app/app.component.ts`, and make sure to modify/delete any tests to get the sample working (tests are still important, you know):
 
 ```ts
 import { Component } from '@angular/core';
-import { AngularFireDatabase, FirebaseListObservable } from 'angularfire2/database';
+import { AngularFirestore } from 'angularfire2/firestore';
 
 @Component({
   selector: 'app-root',
   templateUrl: 'app.component.html',
   styleUrls: ['app.component.css']
 })
 export class AppComponent {
-  constructor(db: AngularFireDatabase) {
+  constructor(db: AngularFirestore) {
 
   }
 }
@@ -177,17 +178,18 @@ In `/src/app/app.component.ts`:
 
 ```ts
 import { Component } from '@angular/core';
-import { AngularFireDatabase, FirebaseListObservable } from 'angularfire2/database';
+import { AngularFirestore } from 'angularfire2/firestore';
+import { Observable } from 'rxjs/Observable';
 
 @Component({
   selector: 'app-root',
   templateUrl: 'app.component.html',
   styleUrls: ['app.component.css']
 })
 export class AppComponent {
-  items: FirebaseListObservable<any[]>;
-  constructor(db: AngularFireDatabase) {
-    this.items = db.list('/items');
+  items: Observable<any[]>;
+  constructor(db: AngularFirestore) {
+    this.items = db.collection('items').valueChanges();
   }
 }
 ```
@@ -197,7 +199,7 @@ Open `/src/app/app.component.html`:
 ```html
 <ul>
   <li class="text" *ngFor="let item of items | async">
-    {{item.$value}}
+    {{item.name}}
   </li>
 </ul>
 ```
@@ -212,35 +214,4 @@ Run the serve command and go to `localhost:4200` in your browser.
 
 And that's it! If it's totally *borked*, file an issue and let us know.
 
-### [Next Step: Retrieving data as objects](2-retrieving-data-as-objects.md)
-
-### Troubleshooting
-
-#### 1. Cannot find namespace 'firebase'.
-
-If you run into this error while trying to invoke `ng serve`, open `src/tsconfig.json` and add the "types" array as follows:
-
-```json
-{
-  "compilerOptions": {
-    ...
-    "typeRoots": [
-      "../node_modules/@types"
-    ],
-
-    // ADD THIS
-    "types": [
-      "firebase"
-    ]
-  }
-}
-```
-
-#### 2. Cannot find name 'require' (This is just a temporary workaround for the Angular CLI).
-
-If you run into this error while trying to invoke `ng serve`, open `src/typings.d.ts` and add the following two entries as follows:
-
-```bash
-declare var require: any;
-declare var module: any;
-```
+### [Next Step: Understanding collections in Firestore](firestore/collections.md)

docs/firestore/collections.md

@@ -217,4 +217,4 @@ To add a new document to a collection with a generated id use the `add()` method
 
 To retrieve, update, or delete an individual document you can use the `doc()` method. This method returns an `AngularFirestoreDocument`, which provides methods for streaming, updating, and deleting. 
 
-See the Documents page for complete documentation.
+See the [Documents page for complete documentation]((docs/firestore/documents.md).

docs/firestore/documents.md

@@ -107,4 +107,4 @@ To retrieve a nested collection use the `collection(path: string)` method.
   }
 ```
 
-For more information about using collections read the collection documentation.
+For more information about using collections read the [collection documentation](docs/firestore/collection.md).