fix(docs): Add how to reset state to docs/guides section

[dbritto-dev]

Related Issues

Fixes #1008

Summary

Move how to reset state to ./docs

Check List

• yarn run prettier for formatting code and docs

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

Latest deployment of this branch, based on commit 8bc6fc0:

Sandbox	Source
React	Configuration
React Typescript	Configuration
React Browserify	Configuration
React Snowpack	Configuration
React Parcel	Configuration

[dai-shi]

Would you create a codesandbox example and add a link?

[dbritto-dev]

@dai-shi how I can do that?. BTW, there's a way to see the docs locally?

[dai-shi]

Just create a codesandbox with https://react.ts.new and copy&paste the code, and see if it's working.

No, I don't think there is such a way.

[dbritto-dev]

@dai-shi here's the demo -> https://codesandbox.io/s/wispy-mountain-gtu0qe?file=/src/App.tsx

[dai-shi]

@dai-shi here's the demo -> https://codesandbox.io/s/wispy-mountain-gtu0qe?file=/src/App.tsx

Cool. Please put it in the md file.

If you can, try to make the demo a little more fancy by showing both "salmon" and "tuna" counts and adding three buttons (addSalmon, addTuna, reset).

[dbritto-dev]

@dai-shi sure I'll do it tomorrow. I'll add the codesandbox to the md and I'll update the codesandox to show both.

[chrisk-7777]

I've been able to run locally (well kind of locally) by doing the following:

• Clone https://github.com/pmndrs/website/
• Separately have Zustand cloned (where you're doing the doc work)
• In the website alter this file src/data/libraries.ts to include your repo (see below for example)
• Create a temp branch (for example temp-docs) on your own fork
• Make changes and push to this temp branch (I just kept rebasing on the top, either way you can delete the branch afterwards)
• Then run the site yarn run dev

Temporary change just while working locally

  zustand: {
    title: 'Zustand',
    url: '/zustand',
    github: 'https://github.com/pmndrs/zustand',
    description: '...',
    icon: zustandIcon.src,
    image: zustandShare.src,
    docs: 'chrisk-7777/zustand/temp-docs/docs', // <-- this line is key
  },

The docs path is:

• chrisk-7777 your github name (or org)
• zustand (leave as is)
• temp-docs your temporary branch name
• docs leave as is

[dbritto-dev]

@chrisk-7777 cool, good to know. I'll work on that later to make it simple (just one command).

[dai-shi]

hmm, tbh, I prefer the codesandbox example for basic usage, not with slices. Sorry if my comment was confusing. You don't need to remove the current example, but add a new one. You can just have two codesandbox links in the doc.

[dbritto-dev]

@dai-shi yeah I was thinking on that. I can create two codesandbox if that's ok.

[dai-shi]

LGTM!