fix(docs): Issue 1120 docs #1231
Conversation
|
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. Latest deployment of this branch, based on commit 1d58fbe:
|
There was a problem hiding this comment.
Awesome stuff @Exalted100
My comments were only "non-actions", so from my perspective this can be merged
| @@ -19,11 +19,11 @@ const useBoundStore = create((set) => ({ | |||
| })) | |||
| ``` | |||
|
|
|||
| See [Splitting the store into separate slices](https://github.com/pmndrs/zustand/blob/main/docs/typescript.md#slices-pattern) for how to define a store with separate slices. | |||
| See [Splitting the store into separate slices](https://github.com/pmndrs/zustand/blob/main/docs/guides/typescript.md#slices-pattern) for how to define a store with separate slices. | |||
There was a problem hiding this comment.
[no action] This highlights a "post launch" action. Once the docs are all squared away, we may need to do a pass and update the links to point to the docs themselves rather than back to the repo.
There was a problem hiding this comment.
@chrisk-7777 We want to make it work to view docs in github. I believe relative paths should work.
| See [Splitting the store into separate slices](https://github.com/pmndrs/zustand/blob/main/docs/guides/typescript.md#slices-pattern) for how to define a store with separate slices. | |
| See [Splitting the store into separate slices](./typescript.md#slices-pattern) for how to define a store with separate slices. |
| @@ -46,12 +46,12 @@ const dispatch = useGrumpyStore((state) => state.dispatch) | |||
| dispatch({ type: types.increase, by: 2 }) | |||
| ``` | |||
|
|
|||
| Or, just use our redux-middleware. It wires up your main-reducer, sets initial state, and adds a dispatch function to the state itself and the vanilla api. Try [this](https://codesandbox.io/s/amazing-kepler-swxol) example. | |||
| You could also use our redux-middleware. It wires up your main reducer, sets initial state, and adds a dispatch function to the state itself and the vanilla api. Check [this example](https://codesandbox.io/s/amazing-kepler-swxol). | |||
There was a problem hiding this comment.
[no action] Small thing, but these longer links are great for accessibility I believe ("this example" vs previous "this") 👍
| @@ -19,11 +19,11 @@ const useBoundStore = create((set) => ({ | |||
| })) | |||
| ``` | |||
|
|
|||
| See [Splitting the store into separate slices](https://github.com/pmndrs/zustand/blob/main/docs/typescript.md#slices-pattern) for how to define a store with separate slices. | |||
| See [Splitting the store into separate slices](https://github.com/pmndrs/zustand/blob/main/docs/guides/typescript.md#slices-pattern) for how to define a store with separate slices. | |||
There was a problem hiding this comment.
@chrisk-7777 We want to make it work to view docs in github. I believe relative paths should work.
| See [Splitting the store into separate slices](https://github.com/pmndrs/zustand/blob/main/docs/guides/typescript.md#slices-pattern) for how to define a store with separate slices. | |
| See [Splitting the store into separate slices](./typescript.md#slices-pattern) for how to define a store with separate slices. |
|
Probably the author of the sandbox removed it. @drcmda is it you? This is also in readme.md. If we don't know how to recover it, let's remove links. |
Related Issues
Fixes #.
Summary
Reviewed the following for grammatical errors and minor style changes:
In those five documents, I encountered two broken links. Both were in
flux-inspired-practice.md. I was able to replace one with the proper code link. However, I couldn't for the second, as I couldn't find the proper link. You can see it right before the last code block in the file, with the text[this example](https://codesandbox.io/s/amazing-kepler-swxol)Check List
yarn run prettierfor formatting code and docs