feat(docs): migrate docs to rspress by dbritto-dev · Pull Request #3432 · pmndrs/zustand

dbritto-dev · 2026-03-18T14:13:05Z

No description provided.

vercel · 2026-03-18T14:13:12Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
zustand-demo	Ready	Preview, Comment	Mar 23, 2026 4:19pm

codesandbox-ci · 2026-03-18T14:13:32Z

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.

pkg-pr-new · 2026-03-18T14:14:18Z

demo
starter
```
npm i https://pkg.pr.new/zustand@3432
```

commit: cc627f6

Copilot

Pull request overview

This PR introduces an Rspress-based documentation website under website/ and updates GitHub Pages deployment to build and publish that site, along with moving static assets into docs/public and updating image references.

Changes:

Add a new website/ package with Rspress config, theme overrides, and lint/format tooling.
Update GitHub Pages workflow to build the Rspress site and deploy the generated artifact.
Move/add docs static assets under docs/public and update README/docs references accordingly.

Reviewed changes

Copilot reviewed 15 out of 18 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
`website/tsconfig.json`	Adds TS/MDX checking config for the Rspress site.
`website/theme/index.tsx`	Overrides the default Rspress home layout to show install tabs.
`website/theme/index.css`	Sets brand/theme CSS variables and minor badge styling.
`website/rspress.config.ts`	Defines Rspress site config, nav/sidebars, plugins, and base/root.
`website/README.md`	Adds local setup/build/preview instructions for the docs site.
`website/package.json`	Defines the `website` package scripts and dev dependencies.
`website/eslint.config.mjs`	Adds an ESLint flat config for the `website` package.
`website/AGENTS.md`	Adds contributor instructions for linting/formatting the `website` package.
`website/.prettierrc`	Sets Prettier config for `website/`.
`website/.prettierignore`	Ignores lockfiles for Prettier in `website/`.
`website/.gitignore`	Ignores `doc_build/` and other generated artifacts in `website/`.
`README.md`	Updates the repository image path to the new `docs/public` location.
`pnpm-workspace.yaml`	Adjusts workspace packages list to include `website`.
`docs/public/favicon.ico`	Adds a favicon asset under `docs/public`.
`docs/public/bear.jpg`	Adds the bear image under `docs/public`.
`docs/learn/getting-started/introduction.md`	Updates the bear image reference to the new `docs/public` location.
`.github/workflows/docs.yml`	Builds the `website` package and deploys it to GitHub Pages.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

dai-shi

Thanks for working on it.
As I said previously, I want ./docs to be neutral and want to deploy to both websites.

dai-shi · 2026-03-18T16:11:44Z

+
 jobs:
  build:
-    uses: pmndrs/docs/.github/workflows/build.yml@v3


We keep deploying to the current website.
So, please do not modify workflows/docs.yml and make it work.

Create a new workflows/website.yml for rspress.

@dai-shi can't be separated because both use gh pages to publish the website. I could try to publish both under different paths but that would be tricky to implement

Oh, I wasn't aware that gh pages is conflicting. Hmm.

#3432 (comment)

dai-shi · 2026-03-18T16:13:05Z


 <div class="flex justify-center mb-4">
-<img src="../../bear.jpg" alt="Logo Zustand" />
+<img src="../../public/bear.jpg" alt="Logo Zustand" />


Can't we keep the original position? If it's a hard requirement of rspress, I may consider a symbolic link as a last resort.

@dai-shi hard requirement, should be under docs/public

@dbritto-dev Can we copy ./docs/bear.jpg ./docs/public/bear.jpg in the GitHub Action?

@dai-shi sure, we can do that

dai-shi · 2026-03-18T16:26:28Z

    steps:
      - id: deployment
-        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
+        uses: actions/deploy-pages@v4


Please keep using commit hash for this and others.

dai-shi

One of the big requests for migrating to rspress was to enable PR preview, which was a real pain previously. Did you give it up?

dbritto-dev · 2026-03-18T16:40:52Z

One of the big requests for migrating to rspress was to enable PR preview, which was a real pain previously. Did you give it up?

@dai-shi yeah—there’s no straightforward way to support previews on GitHub Pages without publishing both versions under subpaths. For now, I’m hosting the preview from my own repo: https://dbritto-dev.github.io/zustand/

dai-shi · 2026-03-18T23:25:07Z

@dbritto-dev

publishing both versions under subpaths

I think it's a great idea. Let's create a new repo (or two if it's easier) only for github pages.

https://github.com/zustandjs/website-preview (use subpaths like /pr-123)
https://github.com/zustandjs/website (for production)

Do you think that helps? Or, does one repo work both for previews and production?

dbritto-dev · 2026-03-18T23:39:07Z

@dbritto-dev

publishing both versions under subpaths

I think it's a great idea. Let's create a new repo (or two if it's easier) only for github pages.

https://github.com/zustandjs/website-preview (use subpaths like /pr-123) https://github.com/zustandjs/website (for production)

Do you think that helps? Or, does one repo work both for previews and production?

@dai-shi gh pages are only one per repo

dai-shi · 2026-03-18T23:53:20Z

gh pages are only one per repo

If you mean we can't deploy to external repo, let's use this action:

https://github.com/peaceiris/actions-gh-pages

It has external_repository option. It requires a deploy key, but I've done this setup before.

dbritto-dev · 2026-03-19T00:43:34Z

gh pages are only one per repo

If you mean we can't deploy to external repo, let's use this action:

https://github.com/peaceiris/actions-gh-pages

It has external_repository option. It requires a deploy key, but I've done this setup before.

we can create a website repo and

gh pages are only one per repo

If you mean we can't deploy to external repo, let's use this action:

https://github.com/peaceiris/actions-gh-pages

It has external_repository option. It requires a deploy key, but I've done this setup before.

Gotcha, lots of work btw

dai-shi · 2026-03-19T01:18:26Z

Gotcha, lots of work btw

Let me know if you need help.

I think we can have just one repo and use it for both production and previews.

/ ---> production
/_previews/ ---> previews (for commits or PRs)

I'm not sure if peaceiris/actions-gh-pages is capable though. Otherwise, we can create two repos.

I think we can delete previews (with actions) when the PR is closed.

dbritto-dev · 2026-03-19T01:30:04Z

@dai-shi let me play with that I'll let you know when I got something working

dbritto-dev added 5 commits March 18, 2026 09:10

feat: add support for rspress website

9aaafcb

feat: update docs to support rspress

bde0dcd

feat: update pnpm stuff

c2ea336

feat: update docs gh workflow

b869e31

feat: update readme

1c1ad6d

dbritto-dev self-assigned this Mar 18, 2026

Copilot AI review requested due to automatic review settings March 18, 2026 14:13

dbritto-dev added the enhancement New feature or request label Mar 18, 2026

vercel Bot deployed to Preview March 18, 2026 14:13 View deployment

feat: fix format

5c15482

Copilot started reviewing on behalf of dbritto-dev March 18, 2026 14:14 View session

vercel Bot deployed to Preview March 18, 2026 14:14 View deployment

Copilot AI reviewed Mar 18, 2026

View reviewed changes

Comment thread website/tsconfig.json Outdated

Comment thread website/package.json

Comment thread website/README.md

Comment thread website/AGENTS.md

Comment thread website/rspress.config.ts

Comment thread .github/workflows/docs.yml Outdated

Comment thread website/package.json

feat: minor changes

2101553

vercel Bot deployed to Preview March 18, 2026 14:22 View deployment

feat: minor changes

c78643e

vercel Bot deployed to Preview March 18, 2026 14:23 View deployment

dai-shi requested changes Mar 18, 2026

View reviewed changes

dai-shi reviewed Mar 18, 2026

View reviewed changes

dbritto-dev added 3 commits March 23, 2026 09:08

feat: update packages

41ac508

feat: update rspress config

6afbb36

feat: fix docs linking

b0da7f3

vercel Bot deployed to Preview March 23, 2026 14:09 View deployment

feat: update docs

4e5f20b

vercel Bot deployed to Preview March 23, 2026 15:42 View deployment

feat: fix callouts

859ff58

vercel Bot deployed to Preview March 23, 2026 15:48 View deployment

feat: minor improvements

cc627f6

vercel Bot deployed to Preview March 23, 2026 16:19 View deployment

Uh oh!

Conversation

dbritto-dev commented Mar 18, 2026

Uh oh!

vercel Bot commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codesandbox-ci Bot commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new Bot commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dai-shi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dbritto-dev Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dai-shi left a comment

Choose a reason for hiding this comment

Uh oh!

dbritto-dev commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dai-shi commented Mar 18, 2026

Uh oh!

dbritto-dev commented Mar 18, 2026

Uh oh!

dai-shi commented Mar 18, 2026

Uh oh!

dbritto-dev commented Mar 19, 2026

Uh oh!

dai-shi commented Mar 19, 2026

Uh oh!

dbritto-dev commented Mar 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vercel Bot commented Mar 18, 2026 •

edited

Loading

codesandbox-ci Bot commented Mar 18, 2026 •

edited

Loading

pkg-pr-new Bot commented Mar 18, 2026 •

edited

Loading

dbritto-dev Mar 18, 2026 •

edited

Loading

dbritto-dev commented Mar 18, 2026 •

edited

Loading