From a116c5b2f8971a28c4664d225e9423b84f34b7c7 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Thu, 23 Apr 2026 10:03:29 +0000 Subject: [PATCH] docs: update README to reflect VitePress migration and pnpm usage --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cfa98b75..1693b975 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Plane Documentation -This website is built using [Docusaurus v3](https://docusaurus.io/) and hosted at [docs.plane.so](https://docs.plane.so/). If you are looking for the developer documentation, see [Plane developer documentation](https://github.com/makeplane/developer-docs). +This website is built using [VitePress v1.6.3](https://vitepress.dev/) and hosted at [docs.plane.so](https://docs.plane.so/). If you are looking for the developer documentation, see [Plane developer documentation](https://github.com/makeplane/developer-docs). ## Overview @@ -25,13 +25,13 @@ The Plane documentation provides detailed information on the following topics: 3. Install dependencies. ```bash - yarn + pnpm install ``` ## Local development ```bash -yarn start +pnpm dev ``` This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. @@ -39,10 +39,10 @@ This command starts a local development server and opens up a browser window. Mo ## Build ```bash -yarn build +pnpm build ``` -This command generates static files into the `build` directory. +This command generates static files into the `docs/.vitepress/dist` directory. ## Contributing