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

Superficial docs for createRoot #393

Open
GiyoMoon opened this issue Dec 19, 2023 · 1 comment
Open

Superficial docs for createRoot #393

GiyoMoon opened this issue Dec 19, 2023 · 1 comment
Labels
help wanted Looking for assistance on this issue solid Related to core Solid

Comments

@GiyoMoon
Copy link
Contributor

GiyoMoon commented Dec 19, 2023

The docs for createRoot lack some important information.

  • Creating a root owner without accepting the dispose function in the callback creates an unowned root
  • What are the differences between an owned and unowned root? (or link to a page mentioning this, if it's explained somewhere else)
  • What is the detachedOwner property for? While there are typescript docs for it, it would still be very helpful to have some examples. It's currently not even mentioned in the docs.

This also applies to solidjs.com/docs.
Link to the current docs: https://docs.solidjs.com/references/api-reference/reactive-utilities/createRoot

@titoBouzout
Copy link
Collaborator

If you know the answer to these questions a PR for this file would be welcome https://github.com/solidjs/solid-docs-next/blob/main/src/routes/reference/reactive-utilities/create-root.mdx

madaxen86 pushed a commit to madaxen86/solid-docs-next that referenced this issue Aug 16, 2024
@LadyBluenotes LadyBluenotes added help wanted Looking for assistance on this issue solid Related to core Solid and removed improve documentation labels Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Looking for assistance on this issue solid Related to core Solid
Projects
None yet
Development

No branches or pull requests

3 participants