docs(forms): update package docs for Signal Forms graduation#69305
docs(forms): update package docs for Signal Forms graduation#69305erkamyaman wants to merge 1 commit into
Conversation
|
@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 APIThis directory contains the signal-based Angular forms API, built on top of See the Signal Forms guide for usage. Not yet supported
|
|
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.
|
|
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. |
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
7b53b77 to
a19e9bc
Compare
Done! Thank you. |
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?
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.mdlisted onlytwo ways to build forms.
What is the new behavior?
packages/forms/signals/PACKAGE.mdde-experimentalized (title, intro,"Not yet supported" list, FAQ).
packages/forms/PACKAGE.mdnow lists three ways to build forms, adding signalforms 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?