chore: Rename the website directory to docs

docs/src/guide/project/changeset.md

@@ -0,0 +1,25 @@
+# Changeset
+
+项目内置了 [changeset](https://github.com/changesets/changesets) 作为版本管理工具。Changeset 是一个版本管理工具，它可以帮助我们更好的管理版本，生成 changelog，以及自动发布。
+
+详细使用方式可查看官方文档，这里不再阐述。如果你不需要它，可以直接忽略。
+
+## 命令行
+
+changeset 命令在项目中已经内置：
+
+### 交互式填写变更集
+
+```bash
+
+pnpm run changeset
+
+```
+
+### 统一提升版本号
+
+```bash
+
+pnpm run version
+
+```

docs/src/guide/project/cli.md

@@ -0,0 +1,131 @@
+---
+outline: deep
+---
+
+# CLI
+
+项目中，提供了一些命令行工具，用于一些常用的操作，代码位于 `scrips` 内。
+
+## vsh
+
+用于一些项目操作，如清理项目、检查项目等。
+
+### 用法
+
+```bash
+pnpm vsh [command] [options]
+
+```
+
+### vsh check-circular
+
+检查整个项目循环引用，如果有循环引用，会在控制台输出循环引用的模块。
+
+#### 用法
+
+```bash
+pnpm vsh check-circular
+
+```
+
+#### 选项
+
+| 选项       | 说明                                |
+| ---------- | ----------------------------------- |
+| `--staged` | 只检查git暂存区内的文件,默认`false` |
+
+### vsh check-dep
+
+检查整个项目依赖情况，并在控制台输出`未使用的依赖`、`未安装的依赖`信息
+
+#### 用法
+
+```bash
+pnpm vsh check-dep
+
+```
+
+### vsh clean
+
+删除项目的`node_modules`、`dist`、`.turbo`等目录，清理项目。
+
+#### 用法
+
+```bash
+pnpm vsh clean
+
+```
+
+#### 选项
+
+| 选项             | 说明                                    |
+| ---------------- | --------------------------------------- |
+| `-r,--recursive` | 递归删除整个项目,默认`true`             |
+| `--del-lock`     | 是否删除`pnpm-lock.yaml`文件,默认`true` |
+
+### vsh lint
+
+对项目进行lint检查，检查项目中的代码是否符合规范。
+
+#### 用法
+
+```bash
+pnpm vsh lint
+
+```
+
+#### 选项
+
+| 选项       | 说明                           |
+| ---------- | ------------------------------ |
+| `--format` | 检查并尝试修复错误,默认`false` |
+
+### vsh publint
+
+对 `Monorepo` 项目进行包规范检查，检查项目中的包是否符合规范。
+
+#### 用法
+
+```bash
+pnpm vsh publint
+
+```
+
+#### 选项
+
+| 选项      | 说明                   |
+| --------- | ---------------------- |
+| `--check` | 仅执行检查,默认`false` |
+
+### vsh code-workspace
+
+生成 `vben-admin.code-workspace` 文件，目前不需要手动执行，会在代码提交时自动执行。
+
+#### 用法
+
+```bash
+pnpm vsh code-workspace
+
+```
+
+#### 选项
+
+| 选项            | 说明                                   |
+| --------------- | -------------------------------------- |
+| `--auto-commit` | `git commit`时候，自动提交,默认`false` |
+| `--spaces`      | 缩进格式,默认 `2`个缩进                |
+
+## turbo-run
+
+用于快速执行大仓中脚本，并提供选项式交互选择。
+
+### 用法
+
+```bash
+pnpm turbo-run [command]
+
+```
+
+### turbo-run dev
+
+快速执行`dev`命令，并提供选项式交互选择。

docs/src/guide/project/standard.md

@@ -0,0 +1,165 @@
+# 规范
+
+::: tip 贡献代码
+
+- 如果你想向项目贡献代码，请确保你的代码符合项目的代码规范。
+- 如果你使用的是 `vscode`，需要安装以下插件：
+
+  - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - 脚本代码检查
+  - [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - 代码格式化
+  - [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) - 单词语法检查
+  - [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) - css 格式化
+
+:::
+
+## 作用
+
+具备基本工程素养的同学都会注重编码规范，而代码风格检查（Code Linting，简称 Lint）是保障代码规范一致性的重要手段。
+
+遵循相应的代码规范有以下好处：
+
+- 较少 bug 错误率
+- 高效的开发效率
+- 更高的可读性
+
+## 工具
+
+项目的配置文件位于 `internal/lint-configs` 下，你可以在这里修改各种lint的配置。
+
+项目内集成了以下几种代码校验工具：
+
+- [ESLint](https://eslint.org/) 用于 JavaScript 代码检查
+- [Stylelint](https://stylelint.io/) 用于 CSS 样式检查
+- [Prettier](https://prettier.io/) 用于代码格式化
+- [Commitlint](https://commitlint.js.org/) 用于检查 git 提交信息的规范
+- [Publint](https://publint.dev/) 用于检查 npm 包的规范
+- [Lint Staged](https://github.com/lint-staged/lint-staged) 用于在 git 提交前运行代码校验
+- [Cspell](https://cspell.org/) 用于检查拼写错误
+
+## ESLint
+
+ESLint 是一个代码规范和错误检查工具，用于识别和报告 TypeScript 代码中的语法错误。
+
+### 命令
+
+```bash
+pnpm eslint .
+```
+
+### 配置
+
+eslint 配置文件为 `eslint.config.mjs`，其核心配置放在`internal/lint-configs/eslint-config`目录下，可以根据项目需求进行修改。
+
+## Stylelint
+
+Stylelint 用于校验项目内部 css 的风格,加上编辑器的自动修复，可以很好的统一项目内部 css 风格
+
+### 命令
+
+```bash
+pnpm stylelint "**/*.{vue,css,less.scss}"
+```
+
+### 配置
+
+Stylelint 配置文件为 `stylelint.config.mjs`，其核心配置放在`internal/lint-configs/stylelint-config`目录下，可以根据项目需求进行修改。
+
+## Prettier
+
+Prettier 可以用于统一项目代码风格，统一的缩进，单双引号，尾逗号等等风格
+
+### 命令
+
+```bash
+pnpm prettier .
+```
+
+### 配置
+
+Prettier 配置文件为 `.prettier.mjs`，其核心配置放在`internal/lint-configs/prettier-config`目录下，可以根据项目需求进行修改。
+
+## CommitLint
+
+在一个团队中，每个人的 git 的 commit 信息都不一样，五花八门，没有一个机制很难保证规范化，如何才能规范化呢？可能你想到的是 git 的 hook 机制，去写 shell 脚本去实现。这当然可以，其实 JavaScript 有一个很好的工具可以实现这个模板，它就是 commitlint（用于校验 git 提交信息规范）。
+
+### 配置
+
+CommitLint 配置文件为 `.commitlintrc.mjs`，其核心配置放在`internal/lint-configs/commitlint-config`目录下，可以根据项目需求进行修改。
+
+### Git 提交规范
+
+参考 [Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
+
+- `feat` 增加新功能
+- `fix` 修复问题/BUG
+- `style` 代码风格相关无影响运行结果的
+- `perf` 优化/性能提升
+- `refactor` 重构
+- `revert` 撤销修改
+- `test` 测试相关
+- `docs` 文档/注释
+- `chore` 依赖更新/脚手架配置修改等
+- `workflow` 工作流改进
+- `ci` 持续集成
+- `types` 类型修改
+
+### 关闭Git提交规范检查
+
+如果你想关闭 Git 提交规范检查，有两种方式：
+
+::: code-group
+
+```bash [临时关闭]
+git commit -m 'feat: add home page' --no-verify
+```
+
+```bash [永久关闭]
+# 在 .husky/commit-msg 内注释以下代码即可
+pnpm exec commitlint --edit "$1" # [!code --]
+```
+
+:::
+
+## Publint
+
+Publint 是一个用于检查 npm 包的规范的工具，可以检查包的版本号是否符合规范，是否符合标准的 ESM 规范包等等。
+
+### 命令
+
+```bash
+pnpm vsh publint
+```
+
+## Cspell
+
+Cspell 是一个用于检查拼写错误的工具，可以检查代码中的拼写错误，避免因为拼写错误导致的 bug。
+
+### 命令
+
+```bash
+pnpm cspell lint \"**/*.ts\"  \"**/README.md\" \".changeset/*.md\" --no-progress
+```
+
+### 配置
+
+cspell 配置文件为 `cspell.json`，可以根据项目需求进行修改。
+
+## Git Hook
+
+git hook 一般结合各种 lint，在 git 提交代码的时候进行代码风格校验，如果校验没通过，则不会进行提交。需要开发者自行修改后再次进行提交
+
+### husky
+
+有一个问题就是校验会校验全部代码，但是我们只想校验我们自己提交的代码，这个时候就可以使用 husky。
+
+最有效的解决方案就是将 Lint 校验放到本地，常见做法是使用 husky 或者 pre-commit 在本地提交之前先做一次 Lint 校验。
+
+项目在 `.husky` 内部定义了相应的 hooks
+
+#### 如何关闭 Husky
+
+如果你想关闭 Husky，直接删除 `.husky` 目录即可。
+
+### lint-staged
+
+用于自动修复提交文件风格问题,其配置文件为 `.lintstagedrc.mjs`，其核心配置放在`internal/lint-configs/lint-staged-config`目录下，可以根据项目需求进行修改。

docs/src/guide/project/tailwindcss.md

@@ -0,0 +1,13 @@
+# Tailwind CSS
+
+[Tailwind CSS](https://tailwindcss.com/) 是一个实用性优先的CSS框架，用于快速构建自定义设计。
+
+## 配置
+
+项目的配置文件位于 `internal/tailwind-config` 下，你可以在这里修改 Tailwind CSS 的配置。
+
+::: tip 包使用 tailwindcss 的限制
+
+当前只有对应的包下面存在 `tailwind.config.mjs` 文件才会启用 tailwindcss 的编译，否则不会启用 tailwindcss。如果你是纯粹的 SDK 包，不需要使用 tailwindcss，可以不用创建 `tailwind.config.mjs` 文件。
+
+:::

docs/src/guide/project/test.md

@@ -0,0 +1,33 @@
+# 单元测试
+
+项目内置了 [Vitest](https://vitest.dev/) 作为单元测试工具。Vitest 是一个基于 Vite 的测试运行器，它提供了一套简单的 API 来编写测试用例。
+
+## 编写测试用例
+
+在项目中，我们约定将测试文件名以 `.test.ts` 结尾，或者存放到`__tests__`目录内。例如，创建一个 `utils.ts` 文件，然后同级目录`utils.spec.ts` 文件，
+
+```ts
+// utils.test.ts
+import { expect, test } from 'vitest';
+import { sum } from './sum';
+
+test('adds 1 + 2 to equal 3', () => {
+  expect(sum(1, 2)).toBe(3);
+});
+```
+
+## 运行测试
+
+在大仓根目录下运行以下命令即可：
+
+```bash
+pnpm test:unit
+```
+
+## 现有单元测试
+
+项目中已经有一些单元测试用例，可以搜索以`.test.ts`结尾的文件查看，在你更改到相关代码时，可以运行单元测试来保证代码的正确性，建议在开发过程中，保持单元测试的覆盖率，且同时在 CI/CD 流程中运行单元测试，保证测试通过在进行项目部署。
+
+现有单元测试情况：
+
+![](/guide/test.png)

docs/src/guide/project/vite.md

@@ -0,0 +1,33 @@
+# Vite Config
+
+项目封装了一层vite配置，并集成了一些插件，方便在多个包以及应用内复用，使用方式如下：
+
+## 应用
+
+```ts
+// vite.config.mts
+import { defineConfig } from '@vben/vite-config';
+
+export default defineConfig(async () => {
+  return {
+    application: {},
+    // vite配置，参考vite官方文档进行覆盖
+    vite: {},
+  };
+});
+```
+
+## 包
+
+```ts
+// vite.config.mts
+import { defineConfig } from '@vben/vite-config';
+
+export default defineConfig(async () => {
+  return {
+    library: {},
+    // vite配置，参考vite官方文档进行覆盖
+    vite: {},
+  };
+});
+```