chore: lgtm ci workflow (#382)

Author: abernier

.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lgtm:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          cache: 'npm'
+          node-version-file: '.nvmrc'
+      - run: npm ci
+      - run: npm run lgtm

.nvmrc

@@ -0,0 +1 @@
+24.9

docs/getting-started/introduction.mdx

@@ -14,9 +14,17 @@ nav: 0
 
 ## INSTALL
 
+-   Install [nvm](https://github.com/nvm-sh/nvm) - Node Version Manager, then:
+
+```bash
+$ nvm install
+$ nvm use
+$ node -v # make sure your version satisfies package.json#engines.node
+```
+
+nb: if you want this node version to be your default nvm's one: `nvm alias default node`
+
 ```sh
-$ git clone https://github.com/pmndrs/docs.git
-$ cd docs
 $ npm ci
 ```
 

package.json

@@ -62,7 +62,8 @@
     "build": "next build",
     "format": "prettier -w src/",
     "lint": "eslint src/**/*.{ts,tsx} && prettier . --check",
-    "prepare": "husky"
+    "prepare": "husky",
+    "lgtm": "npm run lint && npm run format && npm run build && echo 'lgtm!' || echo 'not good to me'"
   },
   "engines": {
     "node": ">=20"