Skip to content

Commit fbf5dae

Browse files
authored
docs: add Node.js >=18 requirement and nvm instructions for docs/ folder & format the readme (RocketChat#1007)
1 parent 70d714c commit fbf5dae

1 file changed

Lines changed: 16 additions & 4 deletions

File tree

packages/docs/README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,37 @@
11
# EmbeddedChat Documentation
22

3-
This is the official documentation website of EmbeddedChat
3+
This is the official documentation website of EmbeddedChat.
4+
5+
> **Node.js Version Requirement**
6+
>
7+
> The `docs/` folder requires **Node.js v18 or higher** to run correctly.
8+
> If you’re using a lower version (e.g., v16.19.0 from other parts of the monorepo), you may encounter errors.
9+
>
10+
> Use [NVM](https://github.com/nvm-sh/nvm) to install and switch to the correct version:
11+
>
12+
> ```bash
13+
> nvm install 18
14+
> nvm use 18
15+
> ```
416
517
### Installation
618
719
```
8-
$ yarn install
20+
yarn install
921
```
1022
1123
### Local Development
1224

1325
```
14-
$ yarn dev
26+
yarn dev
1527
```
1628

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

1931
### Build
2032

2133
```
22-
$ yarn build
34+
yarn build
2335
```
2436

2537
This command generates static content into the `build` directory and can be served using any static contents hosting service.

0 commit comments

Comments
 (0)