Sitelet https://github.com/angular/angular/pull/69305
Skip to content

docs(forms): update package docs for Signal Forms graduation - #69305

Merged
kirjs merged 1 commit into
angular:mainfrom
erkamyaman:docs-forms-signal-forms-graduation
Jun 22, 2026
Merged

docs(forms): update package docs for Signal Forms graduation#69305
kirjs merged 1 commit into
angular:mainfrom
erkamyaman:docs-forms-signal-forms-graduation

Conversation

@erkamyaman

@erkamyaman erkamyaman commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

After #68581 graduated the Signal Forms APIs to public API and #68654 removed the experimental warnings from the Signal Forms documentation in adev, the package READMEs still framed the API as experimental.

Update packages/forms/signals/PACKAGE.md: drop the experimental title and intro, remove the now-shipped entries from "Not yet supported" (interop with reactive/template forms and strongly-typed binding to UI controls), and remove the remaining experimental and exploratory wording from the FAQ.

Update packages/forms/PACKAGE.md: it listed only two ways to build forms (reactive and template-driven). Add signal forms as the third.

Fixes #68724

PR Checklist

Please check to confirm your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

What is the current behavior?

Fixes #68724. Post-graduation (#68581, #68654), the forms package READMEs still
framed Signal Forms as experimental, and packages/forms/PACKAGE.md listed only
two ways to build forms.

What is the new behavior?

  • packages/forms/signals/PACKAGE.md de-experimentalized (title, intro,
    "Not yet supported" list, FAQ).
  • packages/forms/PACKAGE.md now lists three ways to build forms, adding signal
    forms with its form() / schema() / [formField] primitives.

Authored and verified with: adev-writing-guide, reference-signal-forms, pr_review,

Does this PR introduce a breaking change?

  • Yes
  • No

@pullapprove
pullapprove Bot requested a review from atscott June 11, 2026 07:41
@angular-robot angular-robot Bot added area: docs Related to the documentation area: forms labels Jun 11, 2026
@ngbot ngbot Bot added this to the Backlog milestone Jun 11, 2026
@atscott
atscott requested review from kirjs and removed request for atscott June 11, 2026 16:28
@atscott

atscott commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

@kirjs is probably better as a reviewer than me but at a glance, I don't think this change goes far enough. Much of the document should just be removed entirely, such as, in my opinion, all of the FAQ

@erkamyaman

erkamyaman commented Jun 11, 2026

Copy link
Copy Markdown
Contributor Author

@kirjs is probably better as a reviewer than me but at a glance, I don't think this change goes far enough. Much of the document should just be removed entirely, such as, in my opinion, all of the FAQ

100% agree! I wanted to remove FAQ actually but I wasn't really sure if it was the right thing to do.

I had roughly something like this in mind.

Signal-based forms API

This directory contains the signal-based Angular forms API, built on top of
signals. It is an alternative to template-driven and reactive
forms that keeps signals at its core, and interoperates with the existing @angular/forms APIs.

See the Signal Forms guide for usage.

Not yet supported

  • Debouncing validation
  • Dynamic objects
  • Tuples

@erkamyaman

erkamyaman commented Jun 11, 2026

Copy link
Copy Markdown
Contributor Author

Thank you for your feedback! @atscott I appreciate it. Let's see @kirjs and other caretakers think about something like this and the current changes. And then I can change it all.

Signal-based forms API

This directory contains the signal-based Angular forms API, built on top of signals. It is an alternative to template-driven and reactive forms that keeps signals at its core, and interoperates with the existing @angular/forms APIs.

See the Signal Forms guide for usage.

Not yet supported

  • Debouncing validation
  • Dynamic objects
  • Tuples

@atscott

atscott commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Sorry, I didn't mean to make it sound like my feedback was just a suggestion with no weight. Please do remove the FAQ. It does not reflect the current state and is no longer relevant.

@erkamyaman
erkamyaman force-pushed the docs-forms-signal-forms-graduation branch from 7b53b77 to a19e9bc Compare June 11, 2026 19:59
@erkamyaman

erkamyaman commented Jun 11, 2026

Copy link
Copy Markdown
Contributor Author

Sorry, I didn't mean to make it sound like my feedback was just a suggestion with no weight. Please do remove the FAQ. It does not reflect the current state and is no longer relevant.

Done! Thank you.

@erkamyaman
docs(forms): update package docs for Signal Forms graduation
ee53b04 
After angular#68581 graduated the Signal Forms APIs to public API and angular#68654 removed
the experimental warnings from the Signal Forms documentation in adev, the
package READMEs still framed the API as experimental.

Update `packages/forms/signals/PACKAGE.md`: drop the experimental title and
intro, remove the now-shipped entries from "Not yet supported" (interop with
reactive/template forms and strongly-typed binding to UI controls), and remove
the remaining experimental and exploratory wording from the FAQ.

Update `packages/forms/PACKAGE.md`: it listed only two ways to build forms
(reactive and template-driven). Add signal forms as the third.

Fixes angular#68724
@erkamyaman
erkamyaman force-pushed the docs-forms-signal-forms-graduation branch from a19e9bc to ee53b04 Compare June 19, 2026 15:56
@erkamyaman

erkamyaman commented Jun 19, 2026

Copy link
Copy Markdown
Contributor Author

rebased on main.

@JeanMeche JeanMeche added action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release labels Jun 19, 2026
@JeanMeche
JeanMeche removed the request for review from kirjs June 19, 2026 16:00
@kirjs
kirjs merged commit 8b1726a into angular:main Jun 22, 2026
24 checks passed
@kirjs

kirjs commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

This PR was merged into the repository. The changes were merged into the following branches:

@erkamyaman
erkamyaman deleted the docs-forms-signal-forms-graduation branch June 23, 2026 01:26
@angular-automatic-lock-bot

angular-automatic-lock-bot Bot commented Jul 24, 2026

Copy link
Copy Markdown

This pull request has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot Bot locked and limited conversation to collaborators Jul 24, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@JeanMeche JeanMeche JeanMeche approved these changes

Assignees

No one assigned

Labels

action: merge The PR is ready for merge by the caretaker area: docs Related to the documentation area: forms target: patch This PR is targeted for the next patch release

Projects

None yet

Milestone

Backlog

Development

Successfully merging this pull request may close these issues.

docs(forms): Signal Forms PACKAGE.md still has experimental framing post-graduation

4 participants

@erkamyaman @atscott @kirjs @JeanMeche