-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
base: main
Are you sure you want to change the base?
Update docs content #2508
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
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. |
@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 |
There was a problem hiding this 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.
The `getState` function lets you access to the current state. It can be stale on asynchronous | ||
operations. |
There was a problem hiding this comment.
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.
@dai-shi thanks, working on that |
Also resolve conflicts please so that we can run CI. |
Sure |
Co-authored-by: Daishi Kato <[email protected]>
Co-authored-by: Daishi Kato <[email protected]>
@dai-shi would you mind review the latest changes? |
There was a problem hiding this 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!
### `create` Signature | ||
|
||
```ts | ||
create<T>()(stateCreatorFn: StateCreator<T, [], []>): UseBoundStore<StoreApi<T>> | ||
``` | ||
|
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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
Summary
Updating docs content
Check List
yarn run prettier
for formatting code and docs