Skip to content

docs: document the 22.0.0-rc.1 changes - #3835

Draft
armando-navarro wants to merge 1 commit into
angular:mainfrom
armando-navarro:rc1-docs
Draft

armando-navarro wants to merge 1 commit into
angular:mainfrom
armando-navarro:rc1-docs

Conversation

@armando-navarro

Copy link
Copy Markdown
Collaborator

Fixes #3834

This is the one docs PR for 22.0.0-rc.1. It stays a draft until the release.

Why one docs PR per release

  • A docs change merged to main shows on GitHub as the current docs immediately, while the behavior it describes ships only in canaries until the next tagged release.
  • Small docs PRs each cost a review and a branch, which slows things down.

How it works

  • A code PR in 22.0.0-rc.1 that changes documented behavior does not carry the docs itself, and they get no PR of their own. They go here as one commit, added when the code PR is filed, and the code PR's description points here.
  • This PR merges just before the 22.0.0-rc.1 tag, after the last code PR it describes, so the docs on main and the published package change together.
  • A fix to docs for behavior that is already released still goes in its own PR, as before.
  • Each commit message says which code PR it documents, so each commit can be reviewed on its own.

Commits so far

Checklist

  • Issue number for this PR: Document the 22.0.0-rc.1 changes #3834
  • Docs included?: yes, this PR is docs only.
  • Test units included?: no, docs only.
  • Breaking change?: no
  • In a clean directory, yarn install, yarn test run successfully?: not applicable, docs only.

docs/zones.md says callback APIs hold the app unstable until an initial
value, so a server render waits for data. angular#3827 makes a set of calls
exceptions because their first callback may never come. Waiting on a
callback that never comes would keep the app from ever becoming stable.

List those calls in docs/zones.md, and point at onValue, object, list,
listVal and fromRef with the value event as the calls that still make a
server render wait.

In docs/database.md, say the same under stateChanges, auditTrail and
fromRef.

Refs angular#3826
@armando-navarro armando-navarro added comp: docs Documentation. type: chore Maintenance with no user-facing behavior change. labels Oct 31, 2026
@armando-navarro armando-navarro added this to the 22.0.0-rc.1 milestone Oct 31, 2026
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.

Document the 22.0.0-rc.1 changes

1 participant

⌂ Proxy