Skip to content

docs: fix stale links and grammar, remove obsolete doc files - #3734

Merged
armando-navarro merged 1 commit into
angular:mainfrom
armando-navarro:docs-b10-link-sweep
Aug 5, 2026
Merged

docs: fix stale links and grammar, remove obsolete doc files#3734
armando-navarro merged 1 commit into
angular:mainfrom
armando-navarro:docs-b10-link-sweep

Conversation

@armando-navarro

Copy link
Copy Markdown
Collaborator

Description

Sweeps a set of small documentation defects: stale links, one incorrect reference link, a wording fix, grammar, and two obsolete files.

  • Point the two angular.io links (docs/compat.md, docs/compat/auth/router-guards.md) at angular.dev.
  • Fix the App Check "Getting Started" link to the reCAPTCHA v3 provider page, matching the ReCaptchaV3Provider sample.
  • docs/zones.md: correct the "Warn" logging-level bullet from "are called" to "are logged".
  • Fix "Provide a" to "Provide an" in the Auth, Analytics, and App Check guides.
  • Delete docs/firebase.json (a dead Firebase Hosting config) and docs/install-angular-cli-windows10.md (an obsolete, orphaned CLI install guide that recommends a deprecated tool).

Documentation only, no source or API changes.

Checklist

Fixes #3733

- 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).
@armando-navarro armando-navarro added comp: docs Documentation. type: chore Maintenance with no user-facing behavior change. labels Aug 4, 2026

@tyler-reitz tyler-reitz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All correct. The App Check link change in particular: the sample uses ReCaptchaV3Provider, which corresponds to the recaptcha-provider page rather than recaptcha-enterprise-provider, so the link now matches the code beside it.

Both deletions are justified. docs/firebase.json is a dead hosting config, and the Windows CLI guide points at windows-build-tools, which is archived — leaving it in place is worse than having no page at all.

Merge-order note: this and #3732 both touch docs/app-check.md and docs/auth.md with adjacent hunks. No overlap in substance, but whichever lands second should be rebased and re-skimmed rather than merged on a stale green.

@armando-navarro
armando-navarro merged commit 3b1096f into angular:main Aug 5, 2026
24 checks passed
@armando-navarro

Copy link
Copy Markdown
Collaborator Author

Thanks Tyler. The ReCaptchaV3Provider point is the one I was least sure about when I wrote it, so it is good to have it confirmed against the sample beside it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp: docs Documentation. type: chore Maintenance with no user-facing behavior change.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: stale links, a wrong reference link, and obsolete files in several guides

2 participants