Update docs content

[dbritto-dev]

UPDATING DOCS CONTENT

Learn 🚧

• Get Started
  • Quick Start
    • Tutorial: Tic-Tac-Toe
    • Thinking in Zustand: motivation, principles, and glossary
  • Installation
    • Start a new Project: vanilla, react, and react native
    • Using TypeScript
• Learn Zustand
  • Managing State
    • Choosing the State Structure: one store, multiple stores, or multiple slices.
    • Colocating Actions
    • Async Data and Data Fetching
    • Selecting Data and Preventing Re-renders with selectors and equality function (react)
    • Isolating State Between Components (react)
  • Middlewares
    • Using Middlewares
    • Writting Immutable Updates with Immer Middleware
    • Persisting State with Persist Middleware
    • Extracting State Logic into a Reducer with Redux and Devtools Middlewares
    • Listening to Selected Data with SubscribeWithSelector Middleware
    • Writing Custom Middleware - TBD
    • Middleware Use Cases
  • Testing
  • Next.js
  • Server-Side Rendering and Hydration
  • Waku - TBD
  • Remix - TBD

Reference 🚧

• APIs
  • create ⚛️
  • createWithEqualityFn ⚛️
  • createStore
  • shallow
• Hooks
  • useStore ⚛️
  • useStoreWithEqualityFn ⚛️
  • useShallow ⚛️
• Middlewares
  • devtools
  • combine
  • persist
  • redux
  • immer
  • subscribeWithSelector

Community 🚧

• Zustand Videos
• Docs Contributors
• Meet the Team - TBD
• Acknowledgements - TBD
• Third-party Libraries
• Versioning Policy

Need help? 🚧

GitHub 🚧

[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	Aug 25, 2024 2:44pm

[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.

[dbritto-dev]

@chosule here you go

[Deanfei]

@dbritto-dev Hi there, I'm starting a new project and noticed the updated documentation in this PR. However, the docs appear to be empty. Could you provide a preview, even if it's incomplete? I need some guidance on using Zustand to structure our new project. Any documentation would be very helpful.

[dbritto-dev]

@Deanfei sure, in the new version of docs we are following React Docs pattern.

But let me list the changes:

• move away from nextjs custom config to vitepress and orama
• new 4 main sections: learn, reference, community and repository.
• each api would be documented including two sections: usage, and troubleshooting
• everything going to have working examples instead of just pieces of code so you can copy paste everything. I'm planning on creating the demos on stackblitz but that would be the last
• typescript first support due to many people struggling with types on zustand
• guides for nextjs (app/pages router), react query, slices pattern, namespaced slices pattern, vitest, bun, support for i18n (would be the last), and other stuff

Note: the docs/reference/create.md is finished so you can review it and let me know if you have any questions. In this first phase we are just updating and restructuring docs, in the second phase we are going to update the website to use vitepress and orama

[dai-shi]

@dbritto-dev Do you plan to work on a new branch?

[dbritto-dev]

@dai-shi yeah, I'll push it soon. I'm updating the changes to match latest pmndrs doc. For now I'm going to push APIs and Hooks and then I'll push Middlewares.