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

Improve documentation #9

Merged
merged 2 commits into from
Apr 8, 2024

Conversation

ueberBrot
Copy link
Contributor

@ueberBrot ueberBrot commented Apr 7, 2024

Key Value
Status Ready for Review
Related Issues n/a
Description Improve and clarify documentation
Type of change Documentation
Is a breaking change No

TODO

  • Own review of the code
  • All tests are passing
  • The code is well documented
  • The documentation website is up-to-date
  • Tests cover new code or fixes

The Preact team has built a great solution and exposing their Signals API to the public and even created bindings for
Several frontend libraries use Signals as their state management solution, including [Svelte V5](https://svelte.dev/blog/runes), [SolidJS](https://www.solidjs.com/tutorial/introduction_signals), [Angular](https://angular.io/guide/signals), [Qwik](https://qwik.dev/docs/components/state/), [Preact](https://preactjs.com/guide/v10/signals/)
(and possibly many more).
Signals are not just a concept for; they can also be used in vanilla JavaScript code to create reactive values.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It feels like there is something missing in this scentence, probably you wanted to write something like this

Suggested change
Signals are not just a concept for; they can also be used in vanilla JavaScript code to create reactive values.
Signals are not just a concept of UI libraries; they can also be used in vanilla JavaScript code to create reactive values.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. The sentence should have been:

"Signals are not just a concept used for UI libraries; they can also be used in vanilla JavaScript code to create reactive values."

I'll fix that

@gutentag2012 gutentag2012 merged commit 55eda09 into gutentag2012:main Apr 8, 2024
2 checks passed
@ueberBrot ueberBrot deleted the chore-refactor-docs branch June 16, 2024 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants