Skip to content

chore: adding more in depth docs for main features #197

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

enyelsequeira
Copy link

Changelog

I have added a more in depth documentation for each concept
please do let me know if my understanding is correct or if i have something wrong

I have decided to add bathc/store together since they kind of go together

Thank you

@KevinVandy @crutchcorn

id: core-effect
---

# Effect Documentation

Choose a reason for hiding this comment

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

Hi, not a maintainer, but just something I think is really important to include in the docs

mount() must be run before the effect will do anything, in addition, mount returns an unmount function which can be used to remove the effect, exactly like you would with the cleanup function in something like useEffect

Copy link

@ViewableGravy ViewableGravy left a comment

Choose a reason for hiding this comment

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

Would love it if we could get this into the docs, since having only the examples for documentation is a bit frustrating

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