Skip to content

Commit 3b1096f

Browse files
docs: fix stale links and grammar, remove obsolete doc files (#3734)
- Point the two angular.io links (compat.md, compat/auth/router-guards.md) at angular.dev, the current home of the Angular documentation. - Fix the App Check Getting Started link to the reCAPTCHA v3 page so it matches the ReCaptchaV3Provider used in the sample. - zones.md: the Warn logging-level bullet described high-risk APIs as "are called" where it means "are logged". - Correct "Provide a" to "Provide an" in the Auth, Analytics, and App Check guides. - Remove docs/firebase.json (a dead Firebase Hosting config for a documentation site that no longer exists) and docs/install-angular-cli-windows10.md (an obsolete, orphaned guide that recommends the npm-deprecated windows-build-tools).
1 parent 88c7b80 commit 3b1096f

8 files changed

Lines changed: 7 additions & 105 deletions

File tree

docs/analytics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ As a prerequisite, ensure that `AngularFire` has been added to your project via
1717
ng add @angular/fire
1818
```
1919

20-
Provide a Analytics instance in the application's `app.config.ts`:
20+
Provide an Analytics instance in the application's `app.config.ts`:
2121

2222
```ts
2323
import { provideFirebaseApp, initializeApp } from '@angular/fire/app';

docs/app-check.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ As a prerequisite, ensure that `AngularFire` has been added to your project via
1717
ng add @angular/fire
1818
```
1919

20-
Provide a App Check instance in the application's `app.config.ts`:
20+
Provide an App Check instance in the application's `app.config.ts`:
2121

2222
```ts
2323
import { provideFirebaseApp, initializeApp } from '@angular/fire/app';
@@ -54,4 +54,4 @@ AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular,
5454

5555
Update the imports from `import { ... } from 'firebase/app-check'` to `import { ... } from '@angular/fire/app-check'` and follow the official documentation.
5656

57-
[Getting Started](https://firebase.google.com/docs/app-check/web/recaptcha-enterprise-provider) | [API Reference](https://firebase.google.com/docs/reference/js/app-check)
57+
[Getting Started](https://firebase.google.com/docs/app-check/web/recaptcha-provider) | [API Reference](https://firebase.google.com/docs/reference/js/app-check)

docs/auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ As a prerequisite, ensure that `AngularFire` has been added to your project via
2020
ng add @angular/fire
2121
```
2222

23-
Provide a Auth instance in the application's `app.config.ts`:
23+
Provide an Auth instance in the application's `app.config.ts`:
2424

2525
```ts
2626
import { provideFirebaseApp, initializeApp } from '@angular/fire/app';

docs/compat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AngularFire
2-
The official [Angular](https://angular.io/) library for [Firebase](https://firebase.google.com/).
2+
The official [Angular](https://angular.dev/) library for [Firebase](https://firebase.google.com/).
33

44
<strong><pre>ng add @angular/fire</pre></strong>
55

docs/compat/auth/router-guards.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Route users with AngularFire guards
22

3-
`AngularFireAuthGuard` provides a prebuilt [`canActivate` Router Guard](https://angular.io/api/router/CanActivate) using `AngularFireAuth`. By default unauthenticated users are not permitted to navigate to protected routes:
3+
`AngularFireAuthGuard` provides a prebuilt [`canActivate` Router Guard](https://angular.dev/api/router/CanActivate) using `AngularFireAuth`. By default unauthenticated users are not permitted to navigate to protected routes:
44

55
> **NOTE**: [AngularFire has a new tree-shakable API](../../../README.md#developer-guide), you're looking at the documentation for the compatability version of the library. [See the v7 upgrade guide for more information on this change.](../../version-7-upgrade.md).
66

docs/firebase.json

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/install-angular-cli-windows10.md

Lines changed: 0 additions & 82 deletions
This file was deleted.

docs/zones.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Instability can be difficult to track down. To help with debugging, AngularFire
5858
There are three logging levels in AngularFire:
5959

6060
* **Silent**: when the logging level is set to silent only the above banner is displayed when AngularFire APIs are called outside of an injection context, this is the default when using Zoneless change-detection.
61-
* **Warn**: when the logging level is set to warn, only blocking reads, long-lived tasks, and APIs with high risk of destabilizing your application are called, this is the default when using ZoneJS.
61+
* **Warn**: when the logging level is set to warn, only blocking reads, long-lived tasks, and APIs with high risk of destabilizing your application are logged, this is the default when using ZoneJS.
6262
* **Verbose**: when the logging level is set to verbose, all AngularFire APIs called outside of an injection context are logged—helping you track down APIs that may be destabilizing your application
6363

6464
You can change the log-level like so:

0 commit comments

Comments
 (0)