Update docs content

[dbritto-dev]

Summary

Updating docs content

Check List

• yarn run prettier for formatting code and docs

[vercel]

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	May 16, 2024 9:48am

[codesandbox-ci]

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]

Just commented some minor things.

For the structure, you might want to ask other members.

[dbritto-dev]

@sewera @chrisk-7777 @charkour your thoughts are welcome -> I'm trying to implement the gists but for now just updating the content and then I'm going to update the website using vitepress https://gist.github.com/dbritto-dev/7fc6abc8afb33e5f98df35e6e0aa7657

[sewera]

I figured you wanted feedback on the structure, not a review, because there are a lot of placeholders there.

I think the structure is fine, the reference section definitely will help. You can consider renaming the learn directory to recipes, because learn suggests a step-by-step guide, a tutorial of some sort in which you can master this library. Something like https://go.dev/learn/ or https://tanstack.com/learn.

The old_docs directory can be renamed to v4 or v4-and-older if you plan to release the new docs together with Zustand v5.

[sewera]

I can also strongly recommend any IntelliJ-based IDE for documentation with the Grazie Pro plugin.

I've got IntelliJ IDEA Ultimate, but it also works with Community Edition and I think the new editor, Writerside.

IntelliJ Community Edition and Writerside are free, so you won't have to pay anything. I haven't tested Writerside, so I don't know about its performance.

You can also check out Vale, a command-line tool, albeit with some IDE integrations, but I haven't tested it either.

[dbritto-dev]

@sewera what about the structure or the topics? do you have a topic in mind that you would like to see

BTW, I don't like intellij-idea but thanks for the suggestions

[sewera]

The structure is good, especially the split between reference and recipes.

One thing I'd do differently is to split it more: recipes, like "Persisting State with Persist Middleware," guides, like "Starting a new project," and reference, like "createWithEqualityFn."

[dbritto-dev]

@sewera btw, I found this tool that use languagetool -> https://marketplace.visualstudio.com/items?itemName=valentjn.vscode-ltex&ssr=false#review-details

[dbritto-dev]

I figured you wanted feedback on the structure, not a review, because there are a lot of placeholders there.

I think the structure is fine, the reference section definitely will help. You can consider renaming the learn directory to recipes, because learn suggests a step-by-step guide, a tutorial of some sort in which you can master this library. Something like https://go.dev/learn/ or https://tanstack.com/learn.

The old_docs directory can be renamed to v4 or v4-and-older if you plan to release the new docs together with Zustand v5.

@sewera actually, I'm following React Docs Pattern -> https://react.dev and there would be a tutorial (tic-tac-toe) same as react docs but with zustand

[sewera]

Alright, that makes sense. Quick start with tic-tac-toe tutorial and installation are in one section, "Get Started," and recipes are in "Learn React."

That's a good idea to use the React pattern, probably the best in this scenario :)

[dbritto-dev]

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

[sewera]

I feel like such functions like setState should be in one place, with hyperlinks to them from, e.g., combine function to avoid copying.

[dbritto-dev]

@sewera that's not supported with the current stuff but when we migrate to vitepress we can move everything in one place and then just import them