Skip to content

Commit dbacd6e

Browse files
authored
Merge pull request #435 from makeplane/cursor/elasticsearch-reference-removal-31f6
docs: update README to reflect VitePress migration and pnpm usage
2 parents 717852c + a116c5b commit dbacd6e

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Plane Documentation
22

3-
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).
3+
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).
44

55
## Overview
66

@@ -25,24 +25,24 @@ The Plane documentation provides detailed information on the following topics:
2525

2626
3. Install dependencies.
2727
```bash
28-
yarn
28+
pnpm install
2929
```
3030

3131
## Local development
3232

3333
```bash
34-
yarn start
34+
pnpm dev
3535
```
3636

3737
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
3838

3939
## Build
4040

4141
```bash
42-
yarn build
42+
pnpm build
4343
```
4444

45-
This command generates static files into the `build` directory.
45+
This command generates static files into the `docs/.vitepress/dist` directory.
4646

4747
## Contributing
4848

0 commit comments

Comments
 (0)