From 26706a081879ec6c648d9e14801a0a242a380715 Mon Sep 17 00:00:00 2001 From: Armando Navarro Date: Tue, 4 Aug 2026 00:58:38 -0700 Subject: [PATCH] docs: fix stale links and grammar, remove obsolete doc files - 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). --- docs/analytics.md | 2 +- docs/app-check.md | 4 +- docs/auth.md | 2 +- docs/compat.md | 2 +- docs/compat/auth/router-guards.md | 2 +- docs/firebase.json | 16 ------ docs/install-angular-cli-windows10.md | 82 --------------------------- docs/zones.md | 2 +- 8 files changed, 7 insertions(+), 105 deletions(-) delete mode 100644 docs/firebase.json delete mode 100644 docs/install-angular-cli-windows10.md diff --git a/docs/analytics.md b/docs/analytics.md index b61c5ab7a..e064730b9 100644 --- a/docs/analytics.md +++ b/docs/analytics.md @@ -17,7 +17,7 @@ As a prerequisite, ensure that `AngularFire` has been added to your project via ng add @angular/fire ``` -Provide a Analytics instance in the application's `app.config.ts`: +Provide an Analytics instance in the application's `app.config.ts`: ```ts import { provideFirebaseApp, initializeApp } from '@angular/fire/app'; diff --git a/docs/app-check.md b/docs/app-check.md index 3c6cd43d5..c98e03e4f 100644 --- a/docs/app-check.md +++ b/docs/app-check.md @@ -17,7 +17,7 @@ As a prerequisite, ensure that `AngularFire` has been added to your project via ng add @angular/fire ``` -Provide a App Check instance in the application's `app.config.ts`: +Provide an App Check instance in the application's `app.config.ts`: ```ts import { provideFirebaseApp, initializeApp } from '@angular/fire/app'; @@ -54,4 +54,4 @@ AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, Update the imports from `import { ... } from 'firebase/app-check'` to `import { ... } from '@angular/fire/app-check'` and follow the official documentation. -[Getting Started](https://firebase.google.com/docs/app-check/web/recaptcha-enterprise-provider) | [API Reference](https://firebase.google.com/docs/reference/js/app-check) +[Getting Started](https://firebase.google.com/docs/app-check/web/recaptcha-provider) | [API Reference](https://firebase.google.com/docs/reference/js/app-check) diff --git a/docs/auth.md b/docs/auth.md index b91469c47..8c810368b 100644 --- a/docs/auth.md +++ b/docs/auth.md @@ -20,7 +20,7 @@ As a prerequisite, ensure that `AngularFire` has been added to your project via ng add @angular/fire ``` -Provide a Auth instance in the application's `app.config.ts`: +Provide an Auth instance in the application's `app.config.ts`: ```ts import { provideFirebaseApp, initializeApp } from '@angular/fire/app'; diff --git a/docs/compat.md b/docs/compat.md index ddd89f3b0..bd8721b25 100644 --- a/docs/compat.md +++ b/docs/compat.md @@ -1,5 +1,5 @@ # AngularFire -The official [Angular](https://angular.io/) library for [Firebase](https://firebase.google.com/). +The official [Angular](https://angular.dev/) library for [Firebase](https://firebase.google.com/). 
ng add @angular/fire
 diff --git a/docs/compat/auth/router-guards.md b/docs/compat/auth/router-guards.md index efce40b59..2a7c28f58 100644 --- a/docs/compat/auth/router-guards.md +++ b/docs/compat/auth/router-guards.md @@ -1,6 +1,6 @@ # Route users with AngularFire guards -`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: +`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: > **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). diff --git a/docs/firebase.json b/docs/firebase.json deleted file mode 100644 index 54cbd6cec..000000000 --- a/docs/firebase.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "firebase": "angular-fire-2", - "public": ".", - "redirects": [ - { - "source": "/", - "destination": "/api", - "type": 302 - } - ], - "ignore": [ - "firebase.json", - "**/.*", - "**/node_modules/**" - ] -} diff --git a/docs/install-angular-cli-windows10.md b/docs/install-angular-cli-windows10.md deleted file mode 100644 index 0226b54b0..000000000 --- a/docs/install-angular-cli-windows10.md +++ /dev/null @@ -1,82 +0,0 @@ -# Installing Angular CLI on Windows 10 - -> There had been installation issues of `@angular/cli` on Windows 10 system. Most of the time these errors are related to Python dependencies and node-gyp. - -Something as below : - -```bash -execSync@1.0.2 install C:\Users\User\AppData\Roaming\npm\node_modules\angu -lar-cli\node_modules\angular2-template-loader\node_modules\codecov\node_modules\ -execSync - node install.js - -[execsync v1.0.2] Attempting to compile native extensions. -{ [Error: spawn node-gyp ENOENT] - code: 'ENOENT', - errno: 'ENOENT', - syscall: 'spawn node-gyp', - path: 'node-gyp', - spawnargs: [ 'rebuild' ] } -[execSync v1.0.2] - Native code compile failed!! - Will try to use win32 extension. -npm WARN deprecated tough-cookie@2.2.2: ReDoS vulnerability parsing Set-Cookie h -ttps://nodesecurity.io/advisories/130 -npm WARN deprecated minimatch@0.3.0: Please update to minimatch 3.0.2 or higher -to avoid a RegExp DoS issue -npm WARN deprecated minimatch@2.0.10: Please update to minimatch 3.0.2 or higher - to avoid a RegExp DoS issue - - node-zopfli@2.0.1 install C:\Users\User\AppData\Roaming\npm\node_modules\a -ngular-cli\node_modules\compression-webpack-plugin\node_modules\node-zopfli - node-pre-gyp install --fallback-to-build -....................... -``` - -To resolve this issue, make sure you've upgraded to the latest version of **NPM** and try installing `@angular/cli` again. This seems to have worked on certain scenarios. - -If the above doesn't work then the below steps should help. Please ensure all the commands are executed as an **Administrator**. - -## Steps: - -### 1) Install `node-gyp` from [here](https://github.com/nodejs/node-gyp) using NPM - -```bash -npm install -g node-gyp -``` - -### 2) Install Windows build tools from [here](https://github.com/felixrieseberg/windows-build-tools) using NPM - -```bash -npm install --global windows-build-tools -``` - -*This will also install Python - -### 3) Install Angular CLI - -```bash -npm install -g @angular/cli -``` - -This should install `@angular/cli` without errors. - -#### Post this installation, follow the installation [guide](https://github.com/angular/angularfire2/blob/master/docs/install-and-setup.md) to install AngularFire and everything should work as expected. - - -### Note: - -When you start your app using `ng serve` in the console, you might still see the below errors. Despite these errors, the application should work as expected and should be able to talk to Firebase. - -```bash -ERROR in [default] C:\angularFire2Test\node_modules\angularfire2\interfaces.d.ts:12:34 -Cannot find namespace 'firebase'. - -ERROR in [default] C:\angularFire2Test\src\typings.d.ts:6:12 -Subsequent variable declarations must have the same type. Variable 'require' must be of type 'NodeRequire', -but here has type 'any'. - -ERROR in [default] C:\angularFire2Test\src\typings.d.ts:7:12 -Subsequent variable declarations must have the same type. Variable 'module' must be of type 'NodeModule', -but here has type 'any'. -``` diff --git a/docs/zones.md b/docs/zones.md index a35f088a6..24a8a088b 100644 --- a/docs/zones.md +++ b/docs/zones.md @@ -58,7 +58,7 @@ Instability can be difficult to track down. To help with debugging, AngularFire There are three logging levels in AngularFire: * **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. -* **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. +* **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. * **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 You can change the log-level like so: