From eab0d81d78cb8a690c06512bb5a960ebcd20c161 Mon Sep 17 00:00:00 2001
From: neverland <chenjiahan.jait@bytedance.com>
Date: Tue, 11 Aug 2026 11:44:22 +0800
Subject: [PATCH] docs(create-rstack): document template scripts

---
 .../create-rstack/template-common/README.md   | 29 ++++++----------
 .../create-rstack/template-doc-i18n/README.md | 27 +++++----------
 packages/create-rstack/template-doc/README.md | 27 +++++----------
 .../template-lib-node-ts/README.md            | 34 +++++--------------
 .../create-rstack/template-lib-node/README.md | 34 +++++--------------
 .../template-lib-react-ts/README.md           | 34 +++++--------------
 .../template-lib-react/README.md              | 34 +++++--------------
 .../template-lib-solid-ts/README.md           | 34 +++++--------------
 .../template-lib-solid/README.md              | 34 +++++--------------
 .../template-lib-svelte-ts/README.md          | 34 +++++--------------
 .../template-lib-svelte/README.md             | 34 +++++--------------
 .../template-lib-vue-ts/README.md             | 34 +++++--------------
 .../create-rstack/template-lib-vue/README.md  | 34 +++++--------------
 13 files changed, 116 insertions(+), 307 deletions(-)

diff --git a/packages/create-rstack/template-common/README.md b/packages/create-rstack/template-common/README.md
index d62a167e..0c5951f1 100644
--- a/packages/create-rstack/template-common/README.md
+++ b/packages/create-rstack/template-common/README.md
@@ -8,25 +8,16 @@ Install the dependencies:
 {{ packageManager }} install
 ```
 
-## Get started
-
-Start the development server:
-
-```bash
-{{ packageManager }} run dev
-```
-
-Build the app for production:
-
-```bash
-{{ packageManager }} run build
-```
-
-Preview the production build locally:
-
-```bash
-{{ packageManager }} run preview
-```
+## Scripts
+
+- `{{ packageManager }} run build`: Build the app for production.
+- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
+- `{{ packageManager }} run dev`: Run the app dev server.
+- `{{ packageManager }} run format`: Format code.
+- `{{ packageManager }} run lint`: Lint code.
+- `{{ packageManager }} run preview`: Preview the app production build.
+- `{{ packageManager }} run test`: Run tests.
+- `{{ packageManager }} run test:watch`: Run tests in watch mode.
 
 ## Learn more
 
diff --git a/packages/create-rstack/template-doc-i18n/README.md b/packages/create-rstack/template-doc-i18n/README.md
index d7963525..6aa686d3 100644
--- a/packages/create-rstack/template-doc-i18n/README.md
+++ b/packages/create-rstack/template-doc-i18n/README.md
@@ -8,25 +8,14 @@ Install the dependencies:
 {{ packageManager }} install
 ```
 
-## Get started
-
-Start the development server:
-
-```bash
-{{ packageManager }} run dev
-```
-
-Build the website for production:
-
-```bash
-{{ packageManager }} run build
-```
-
-Preview the production build locally:
-
-```bash
-{{ packageManager }} run preview
-```
+## Scripts
+
+- `{{ packageManager }} run build`: Build the documentation site for production.
+- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
+- `{{ packageManager }} run dev`: Start the documentation dev server.
+- `{{ packageManager }} run format`: Format code.
+- `{{ packageManager }} run lint`: Lint code.
+- `{{ packageManager }} run preview`: Preview the production build locally.
 
 ## Learn more
 
diff --git a/packages/create-rstack/template-doc/README.md b/packages/create-rstack/template-doc/README.md
index 513fc4a9..849036d5 100644
--- a/packages/create-rstack/template-doc/README.md
+++ b/packages/create-rstack/template-doc/README.md
@@ -8,25 +8,14 @@ Install the dependencies:
 {{ packageManager }} install
 ```
 
-## Get started
-
-Start the development server:
-
-```bash
-{{ packageManager }} run dev
-```
-
-Build the website for production:
-
-```bash
-{{ packageManager }} run build
-```
-
-Preview the production build locally:
-
-```bash
-{{ packageManager }} run preview
-```
+## Scripts
+
+- `{{ packageManager }} run build`: Build the documentation site for production.
+- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
+- `{{ packageManager }} run dev`: Start the documentation dev server.
+- `{{ packageManager }} run format`: Format code.
+- `{{ packageManager }} run lint`: Lint code.
+- `{{ packageManager }} run preview`: Preview the production build locally.
 
 ## Learn more
 
diff --git a/packages/create-rstack/template-lib-node-ts/README.md b/packages/create-rstack/template-lib-node-ts/README.md
index ab4b6927..b0746dfb 100644
--- a/packages/create-rstack/template-lib-node-ts/README.md
+++ b/packages/create-rstack/template-lib-node-ts/README.md
@@ -8,31 +8,15 @@ Install the dependencies:
 {{ packageManager }} install
 ```
 
-## Get started
-
-Build the library:
-
-```bash
-{{ packageManager }} run build
-```
-
-Build the library in watch mode:
-
-```bash
-{{ packageManager }} run dev
-```
-
-Run tests:
-
-```bash
-{{ packageManager }} run test
-```
-
-Run tests in watch mode:
-
-```bash
-{{ packageManager }} run test:watch
-```
+## Scripts
+
+- `{{ packageManager }} run build`: Build the library.
+- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
+- `{{ packageManager }} run dev`: Build the library in watch mode.
+- `{{ packageManager }} run format`: Format code.
+- `{{ packageManager }} run lint`: Lint code.
+- `{{ packageManager }} run test`: Run tests.
+- `{{ packageManager }} run test:watch`: Run tests in watch mode.
 
 ## Learn more
 
diff --git a/packages/create-rstack/template-lib-node/README.md b/packages/create-rstack/template-lib-node/README.md
index ab4b6927..b0746dfb 100644
--- a/packages/create-rstack/template-lib-node/README.md
+++ b/packages/create-rstack/template-lib-node/README.md
@@ -8,31 +8,15 @@ Install the dependencies:
 {{ packageManager }} install
 ```
 
-## Get started
-
-Build the library:
-
-```bash
-{{ packageManager }} run build
-```
-
-Build the library in watch mode:
-
-```bash
-{{ packageManager }} run dev
-```
-
-Run tests:
-
-```bash
-{{ packageManager }} run test
-```
-
-Run tests in watch mode:
-
-```bash
-{{ packageManager }} run test:watch
-```
+## Scripts
+
+- `{{ packageManager }} run build`: Build the library.
+- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
+- `{{ packageManager }} run dev`: Build the library in watch mode.
+- `{{ packageManager }} run format`: Format code.
+- `{{ packageManager }} run lint`: Lint code.
+- `{{ packageManager }} run test`: Run tests.
+- `{{ packageManager }} run test:watch`: Run tests in watch mode.
 
 ## Learn more
 
diff --git a/packages/create-rstack/template-lib-react-ts/README.md b/packages/create-rstack/template-lib-react-ts/README.md
index ab4b6927..b0746dfb 100644
--- a/packages/create-rstack/template-lib-react-ts/README.md
+++ b/packages/create-rstack/template-lib-react-ts/README.md
@@ -8,31 +8,15 @@ Install the dependencies:
 {{ packageManager }} install
 ```
 
-## Get started
-
-Build the library:
-
-```bash
-{{ packageManager }} run build
-```
-
-Build the library in watch mode:
-
-```bash
-{{ packageManager }} run dev
-```
-
-Run tests:
-
-```bash
-{{ packageManager }} run test
-```
-
-Run tests in watch mode:
-
-```bash
-{{ packageManager }} run test:watch
-```
+## Scripts
+
+- `{{ packageManager }} run build`: Build the library.
+- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
+- `{{ packageManager }} run dev`: Build the library in watch mode.
+- `{{ packageManager }} run format`: Format code.
+- `{{ packageManager }} run lint`: Lint code.
+- `{{ packageManager }} run test`: Run tests.
+- `{{ packageManager }} run test:watch`: Run tests in watch mode.
 
 ## Learn more
 
diff --git a/packages/create-rstack/template-lib-react/README.md b/packages/create-rstack/template-lib-react/README.md
index ab4b6927..b0746dfb 100644
--- a/packages/create-rstack/template-lib-react/README.md
+++ b/packages/create-rstack/template-lib-react/README.md
@@ -8,31 +8,15 @@ Install the dependencies:
 {{ packageManager }} install
 ```
 
-## Get started
-
-Build the library:
-
-```bash
-{{ packageManager }} run build
-```
-
-Build the library in watch mode:
-
-```bash
-{{ packageManager }} run dev
-```
-
-Run tests:
-
-```bash
-{{ packageManager }} run test
-```
-
-Run tests in watch mode:
-
-```bash
-{{ packageManager }} run test:watch
-```
+## Scripts
+
+- `{{ packageManager }} run build`: Build the library.
+- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
+- `{{ packageManager }} run dev`: Build the library in watch mode.
+- `{{ packageManager }} run format`: Format code.
+- `{{ packageManager }} run lint`: Lint code.
+- `{{ packageManager }} run test`: Run tests.
+- `{{ packageManager }} run test:watch`: Run tests in watch mode.
 
 ## Learn more
 
diff --git a/packages/create-rstack/template-lib-solid-ts/README.md b/packages/create-rstack/template-lib-solid-ts/README.md
index ab4b6927..b0746dfb 100644
--- a/packages/create-rstack/template-lib-solid-ts/README.md
+++ b/packages/create-rstack/template-lib-solid-ts/README.md
@@ -8,31 +8,15 @@ Install the dependencies:
 {{ packageManager }} install
 ```
 
-## Get started
-
-Build the library:
-
-```bash
-{{ packageManager }} run build
-```
-
-Build the library in watch mode:
-
-```bash
-{{ packageManager }} run dev
-```
-
-Run tests:
-
-```bash
-{{ packageManager }} run test
-```
-
-Run tests in watch mode:
-
-```bash
-{{ packageManager }} run test:watch
-```
+## Scripts
+
+- `{{ packageManager }} run build`: Build the library.
+- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
+- `{{ packageManager }} run dev`: Build the library in watch mode.
+- `{{ packageManager }} run format`: Format code.
+- `{{ packageManager }} run lint`: Lint code.
+- `{{ packageManager }} run test`: Run tests.
+- `{{ packageManager }} run test:watch`: Run tests in watch mode.
 
 ## Learn more
 
diff --git a/packages/create-rstack/template-lib-solid/README.md b/packages/create-rstack/template-lib-solid/README.md
index ab4b6927..b0746dfb 100644
--- a/packages/create-rstack/template-lib-solid/README.md
+++ b/packages/create-rstack/template-lib-solid/README.md
@@ -8,31 +8,15 @@ Install the dependencies:
 {{ packageManager }} install
 ```
 
-## Get started
-
-Build the library:
-
-```bash
-{{ packageManager }} run build
-```
-
-Build the library in watch mode:
-
-```bash
-{{ packageManager }} run dev
-```
-
-Run tests:
-
-```bash
-{{ packageManager }} run test
-```
-
-Run tests in watch mode:
-
-```bash
-{{ packageManager }} run test:watch
-```
+## Scripts
+
+- `{{ packageManager }} run build`: Build the library.
+- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
+- `{{ packageManager }} run dev`: Build the library in watch mode.
+- `{{ packageManager }} run format`: Format code.
+- `{{ packageManager }} run lint`: Lint code.
+- `{{ packageManager }} run test`: Run tests.
+- `{{ packageManager }} run test:watch`: Run tests in watch mode.
 
 ## Learn more
 
diff --git a/packages/create-rstack/template-lib-svelte-ts/README.md b/packages/create-rstack/template-lib-svelte-ts/README.md
index ab4b6927..b0746dfb 100644
--- a/packages/create-rstack/template-lib-svelte-ts/README.md
+++ b/packages/create-rstack/template-lib-svelte-ts/README.md
@@ -8,31 +8,15 @@ Install the dependencies:
 {{ packageManager }} install
 ```
 
-## Get started
-
-Build the library:
-
-```bash
-{{ packageManager }} run build
-```
-
-Build the library in watch mode:
-
-```bash
-{{ packageManager }} run dev
-```
-
-Run tests:
-
-```bash
-{{ packageManager }} run test
-```
-
-Run tests in watch mode:
-
-```bash
-{{ packageManager }} run test:watch
-```
+## Scripts
+
+- `{{ packageManager }} run build`: Build the library.
+- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
+- `{{ packageManager }} run dev`: Build the library in watch mode.
+- `{{ packageManager }} run format`: Format code.
+- `{{ packageManager }} run lint`: Lint code.
+- `{{ packageManager }} run test`: Run tests.
+- `{{ packageManager }} run test:watch`: Run tests in watch mode.
 
 ## Learn more
 
diff --git a/packages/create-rstack/template-lib-svelte/README.md b/packages/create-rstack/template-lib-svelte/README.md
index ab4b6927..b0746dfb 100644
--- a/packages/create-rstack/template-lib-svelte/README.md
+++ b/packages/create-rstack/template-lib-svelte/README.md
@@ -8,31 +8,15 @@ Install the dependencies:
 {{ packageManager }} install
 ```
 
-## Get started
-
-Build the library:
-
-```bash
-{{ packageManager }} run build
-```
-
-Build the library in watch mode:
-
-```bash
-{{ packageManager }} run dev
-```
-
-Run tests:
-
-```bash
-{{ packageManager }} run test
-```
-
-Run tests in watch mode:
-
-```bash
-{{ packageManager }} run test:watch
-```
+## Scripts
+
+- `{{ packageManager }} run build`: Build the library.
+- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
+- `{{ packageManager }} run dev`: Build the library in watch mode.
+- `{{ packageManager }} run format`: Format code.
+- `{{ packageManager }} run lint`: Lint code.
+- `{{ packageManager }} run test`: Run tests.
+- `{{ packageManager }} run test:watch`: Run tests in watch mode.
 
 ## Learn more
 
diff --git a/packages/create-rstack/template-lib-vue-ts/README.md b/packages/create-rstack/template-lib-vue-ts/README.md
index ab4b6927..b0746dfb 100644
--- a/packages/create-rstack/template-lib-vue-ts/README.md
+++ b/packages/create-rstack/template-lib-vue-ts/README.md
@@ -8,31 +8,15 @@ Install the dependencies:
 {{ packageManager }} install
 ```
 
-## Get started
-
-Build the library:
-
-```bash
-{{ packageManager }} run build
-```
-
-Build the library in watch mode:
-
-```bash
-{{ packageManager }} run dev
-```
-
-Run tests:
-
-```bash
-{{ packageManager }} run test
-```
-
-Run tests in watch mode:
-
-```bash
-{{ packageManager }} run test:watch
-```
+## Scripts
+
+- `{{ packageManager }} run build`: Build the library.
+- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
+- `{{ packageManager }} run dev`: Build the library in watch mode.
+- `{{ packageManager }} run format`: Format code.
+- `{{ packageManager }} run lint`: Lint code.
+- `{{ packageManager }} run test`: Run tests.
+- `{{ packageManager }} run test:watch`: Run tests in watch mode.
 
 ## Learn more
 
diff --git a/packages/create-rstack/template-lib-vue/README.md b/packages/create-rstack/template-lib-vue/README.md
index ab4b6927..b0746dfb 100644
--- a/packages/create-rstack/template-lib-vue/README.md
+++ b/packages/create-rstack/template-lib-vue/README.md
@@ -8,31 +8,15 @@ Install the dependencies:
 {{ packageManager }} install
 ```
 
-## Get started
-
-Build the library:
-
-```bash
-{{ packageManager }} run build
-```
-
-Build the library in watch mode:
-
-```bash
-{{ packageManager }} run dev
-```
-
-Run tests:
-
-```bash
-{{ packageManager }} run test
-```
-
-Run tests in watch mode:
-
-```bash
-{{ packageManager }} run test:watch
-```
+## Scripts
+
+- `{{ packageManager }} run build`: Build the library.
+- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
+- `{{ packageManager }} run dev`: Build the library in watch mode.
+- `{{ packageManager }} run format`: Format code.
+- `{{ packageManager }} run lint`: Lint code.
+- `{{ packageManager }} run test`: Run tests.
+- `{{ packageManager }} run test:watch`: Run tests in watch mode.
 
 ## Learn more