Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Full-stack Signals] Add documentation for Full-stack Signals #3762

Open
taefi opened this issue Oct 2, 2024 · 0 comments
Open

[Full-stack Signals] Add documentation for Full-stack Signals #3762

taefi opened this issue Oct 2, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request hilla

Comments

@taefi
Copy link
Contributor

taefi commented Oct 2, 2024

The Full-stack Signals feature needs to covered in a documentation, that mentions the followings:

  • It is a preview feature - How the feature flag should be enabled
  • The available types should be introduced with examples:
    • ValueSignal
    • NumberSignal (as a specialized ValueSignal with an atomic extra operation)
    • ListSignal
  • How to enable the security
  • known limitations in this version
@taefi taefi added enhancement New feature or request hilla labels Oct 2, 2024
@taefi taefi self-assigned this Oct 10, 2024
taefi added a commit that referenced this issue Oct 10, 2024
taefi added a commit that referenced this issue Oct 22, 2024
* feat: add initial Full-stack Signals documentation

Part of #3762

* add service method params and ValueSignal

* add service method params and ValueSignal

* add numbersignal documentation

* Apply suggestions from code review

Co-authored-by: Luciano Vernaschi <[email protected]>
Co-authored-by: Serhii Kulykov <[email protected]>

* apply suggestions from review

* apply suggestions from review

* fix Vale warnings and errors

* Initial minor edits and Vale fixes

* Apply suggestions from code review

Co-authored-by: Luciano Vernaschi <[email protected]>

* apply suggestions from review

* Full edit of new document.

* Vale fix.

* More Vale fixes.

* Second full edit of new document.

---------

Co-authored-by: Luciano Vernaschi <[email protected]>
Co-authored-by: Serhii Kulykov <[email protected]>
Co-authored-by: russelljtdyer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hilla
Projects
None yet
Development

No branches or pull requests

1 participant