Skip to content

docs(compat): state the compatibility API's support status - #3810

Open
armando-navarro wants to merge 1 commit into
angular:mainfrom
armando-navarro:b35-compat-status
Open

armando-navarro wants to merge 1 commit into
angular:mainfrom
armando-navarro:b35-compat-status

Conversation

@armando-navarro

Copy link
Copy Markdown
Collaborator

Checklist

  • Issue number for this PR: Recommended API Version #3336
  • Docs included?: yes, this is a docs-only change.
  • Test units included?: no, Markdown only.
  • Breaking change?: no.
  • In a clean directory, yarn install, yarn test run successfully? Not run, the change is two Markdown files. npm run lint passed.

Description

docs/compat.md never said whether @angular/fire/compat is supported, and the v7 upgrade guide still told readers to stop at the compatibility API because the modular API "isn't feature complete", a sentence from the 7.0 release. #3336 asked for a direct answer in 2023 and never got one. This writes the answer down.

Changes

  • docs/compat.md gets a "Support status" section: the compatibility API is supported and kept working on every Angular and Firebase version AngularFire supports, its specs run in the same test suite as the modular API, it receives bug fixes and no new features, and there is no planned removal date. Readers who depend on it can keep upgrading without migrating.
  • docs/version-7-upgrade.md: the bolded line becomes "You can stop here if the compatibility API covers your needs.", followed by the support summary and a link to the new section.

Fixes #3336

docs/compat.md had no statement of whether @angular/fire/compat is
supported, and the v7 upgrade guide still told readers to stop at the
compatibility API because the modular API was not feature complete,
a sentence written for the 7.0 release.

The new section records the decision for 22: the compatibility API is
supported and kept working, its specs run in the same suite, it
receives bug fixes and no new features, and no removal is planned.
The v7 guide line now points at that section.
@armando-navarro armando-navarro added bump: patch Size of the change: a fix or docs change that reaches users comp: compat Compatibility layer for the pre-modular API (src/compat). comp: docs Documentation. type: chore Maintenance with no user-facing behavior change. labels Oct 23, 2026
@armando-navarro armando-navarro added this to the 22.0.0-rc.0 milestone Oct 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bump: patch Size of the change: a fix or docs change that reaches users comp: compat Compatibility layer for the pre-modular API (src/compat). 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.

Recommended API Version

2 participants