refactor(package.json): add docs.dev & docs.preview

Add pnpm docs.dev & pnpm docs.preview commands to improve the DX for contributors.
QwikDev · Nov 3, 2023 · a1f978b · a1f978b
1 parent 0ff98d3
commit a1f978b
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -223,7 +223,7 @@ pnpm install
 2. Run the docs site:
 
 ```shell
-cd packages/docs && pnpm start
+pnpm docs.dev
 ```
 
 ### To open the test apps for debugging run:

diff --git a/package.json b/package.json
@@ -121,6 +121,8 @@
     "cli.validate": "tsm scripts/validate-cli.ts",
     "commit": "git-cz",
     "deps": "pnpm upgrade -i -r --latest",
+    "docs.dev": "cd packages/docs && pnpm dev",
+    "docs.preview": "cd packages/docs && pnpm preview",
     "docs.sync": "tsm scripts/docs_sync/index.ts && pnpm fmt",
     "eslint.update": "tsm scripts/eslint-docs.ts",
     "fmt": "pnpm prettier.fix && pnpm syncpack format",

diff --git a/scripts/index.ts b/scripts/index.ts
@@ -1,5 +1,5 @@
 /**
- * This is the root build scripts module (keep in commonjs). It's only a .js file but will handling
+ * This is the root build scripts module (keep in commonjs). It's only a .js file but will handle
  * registering typescript files with esbuild-register to allow Node.js to build .ts files
  * on-demand.
  */