Update docs content #2508
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. |
| `createStore` returns a vanilla store with some API utilities. These API utilities are: `setState` | ||
| function, `getState` function, and `subscribe` function. | ||
|
|
||
| ### `setState` function |
There was a problem hiding this comment.
I feel like such functions like setState should be in one place, with hyperlinks to them from, e.g., combine function to avoid copying.
There was a problem hiding this comment.
@sewera that's not supported with the current setup but when we migrate to vitepress we can move everything in one place and then just import them
|
@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 |
docs/reference/combine.md
Outdated
| [`getState` function](#getstate-function) and [`storeApi`](#storeapi) as arguments. It should | ||
| return an additional state based on the initial state. |
|
|
||
| #### Returns | ||
|
|
||
| `combine` returns a new state that is the result of merging the initial state and the additional |
There was a problem hiding this comment.
More precisely, combine and any other middleware "returns" a state creator.
| The `getState` function lets you access to the current state. It can be stale on asynchronous | ||
| operations. |
There was a problem hiding this comment.
Not sure if "stale on async operations" is technically correct.
docs/reference/combine.md
Outdated
| ### `combine` Signature | ||
|
|
||
| ```ts | ||
| combine<T, U>(initialState: T, additionalStateCreator: StateCreator<T, [], [], U>): Omit<T, keyof U> & U |
There was a problem hiding this comment.
Shouldn't we clarify where we can import this from? combine is from zustand/middleware.
There was a problem hiding this comment.
There's a usage section where we can put it
|
@dai-shi thanks, working on that |
|
Also resolve conflicts please so that we can run CI. |
Sure |
Co-authored-by: Daishi Kato <dai-shi@users.noreply.github.com>
Co-authored-by: Daishi Kato <dai-shi@users.noreply.github.com>
Summary
Updating docs content
Check List
yarn run prettierfor formatting code and docs