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

Update docs content #2508

Draft
wants to merge 41 commits into
base: main
Choose a base branch
from
Draft

Conversation

dbritto-dev
Copy link
Collaborator

Summary

Updating docs content

Check List

  • yarn run prettier for formatting code and docs

Copy link

vercel bot commented Apr 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
zustand-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 13, 2024 1:44am

Copy link

codesandbox-ci bot commented Apr 24, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

@dbritto-dev
Copy link
Collaborator Author

@charkour @dai-shi @sewera would you mind reviewing the docs under reference and tell me your thoughts?

@dai-shi dai-shi mentioned this pull request May 22, 2024
16 tasks
@dbritto-dev
Copy link
Collaborator Author

@dai-shi lmk what you think about reference section and documentation, still working on usage and troubleshooting section but apart from that everything else should be done on reference section

Copy link
Member

@dai-shi dai-shi left a comment

Choose a reason for hiding this comment

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

Reviewed the reference docs.

docs/reference/combine.md Outdated Show resolved Hide resolved
docs/reference/combine.md Outdated Show resolved Hide resolved
docs/reference/create-context.md Outdated Show resolved Hide resolved
Comment on lines +76 to +77
The `getState` function lets you access to the current state. It can be stale on asynchronous
operations.
Copy link
Member

Choose a reason for hiding this comment

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

Not sure if "stale on async operations" is technically correct.

docs/reference/create-with-equality-fn.md Outdated Show resolved Hide resolved
docs/reference/create-with-equality-fn.md Outdated Show resolved Hide resolved
docs/reference/combine.md Outdated Show resolved Hide resolved
docs/reference/create.md Outdated Show resolved Hide resolved
docs/reference/shallow.md Outdated Show resolved Hide resolved
docs/reference/use-shallow.md Outdated Show resolved Hide resolved
@dbritto-dev
Copy link
Collaborator Author

@dai-shi thanks, working on that

@dai-shi
Copy link
Member

dai-shi commented Jun 2, 2024

Also resolve conflicts please so that we can run CI.

@dbritto-dev
Copy link
Collaborator Author

Also resolve conflicts please so that we can run CI.

Sure

@dbritto-dev
Copy link
Collaborator Author

@dai-shi would you mind review the latest changes?

Copy link
Member

@dai-shi dai-shi left a comment

Choose a reason for hiding this comment

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

thanks for working on it!

docs/reference/create-store.md Show resolved Hide resolved
docs/reference/devtools.md Outdated Show resolved Hide resolved
docs/reference/immer.md Show resolved Hide resolved
Comment on lines +31 to +36
### `create` Signature

```ts
create<T>()(stateCreatorFn: StateCreator<T, [], []>): UseBoundStore<StoreApi<T>>
```

Copy link
Member

Choose a reason for hiding this comment

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

It would be nice if we could teach what a bound hook is.

Copy link
Collaborator Author

@dbritto-dev dbritto-dev Jun 13, 2024

Choose a reason for hiding this comment

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

@dai-shi any other concept that we need to explain? something like store api (utilities), selectors, etc? I'm adding a new section called core concepts to talk about those

Copy link
Member

Choose a reason for hiding this comment

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

(Did I miss this comment?)

Yeah, "core concepts" sound nice.

btw, #2138 is ready. I was hoping to merge #2508 in advance to it, but I think either way works.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@dai-shi yeah, still working on it I'll try to close reference docs and then work on learn docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants