docs(projects): 文档更新

README.md

@@ -12,18 +12,21 @@
 
 ## 简介
 
-Soybean Admin 是一个基于 Vue3、Vite、Naive UI、TypeScript 的中后台解决方案，它使用了最新的前端技术栈，并提炼了典型的业务模型，页面，包括二次封装组件、动态菜单、权限校验、粒子化权限控制等功能，它可以帮助你快速搭建企业级中后台项目，相信不管是从新技术使用还是其他方面，都能帮助到你。
+Soybean Admin 是一个基于 Vue3、Vite、Naive UI、TypeScript 的免费中后台模版，它使用了最新的前端技术栈，内置丰富的插件，有着极高的代码规范，
+
+开箱即用的中后台前端解决方案，也可用于学习参考。
 
 ## 特性
 
 - **最新技术栈**：使用 Vue3/vite2 等前端前沿技术开发, 使用高效率的npm包管理器pnpm
 - **TypeScript**: 应用程序级 JavaScript 的语言
-- **主题**：可配置的主题
-- **代码规范**：丰富的规范插件及极高规范的代码组织
+- **主题**：丰富可配置的主题
+- **代码规范**：丰富的规范插件及极高的代码规范
+- **路由配置**：简易的路由配置
 
 ## 预览
 
-- [soybean-admin](https://soybean.pro/) - 站点
+- [soybean-admin](https://soybean.pro/)
 
 
 ## 目录规范
@@ -41,8 +44,8 @@ soybean-admin
 │       └── windicss.ts        //css框架插件
 ├── doc                        //项目相关说明文档
 ├── public                     //公共目录
-│   ├── resource               //资源文件夹(不会被打包)
-│   └── favicon.ico
+│   ├── resource               //资源文件夹(打包后会保留到dist根目录)
+│   └── favicon.ico            //网站标签图标
 ├── src
 │   ├── assets                 //静态资源
 │   ├── components             //全局组件
@@ -57,7 +60,7 @@ soybean-admin
 │   │   ├── business.ts        //业务相关枚举
 │   │   ├── common.ts          //通用枚举
 │   │   ├── route.ts           //路由相关枚举
-│   │   ├── storage.ts           //存储相关枚举
+│   │   ├── storage.ts         //存储相关枚举
 │   │   └── theme.ts           //系统主题配置相关枚举
 │   ├── hooks                  //组合式的钩子函数hooks
 │   │   ├── business           //业务相关hooks
@@ -67,41 +70,43 @@ soybean-admin
 │   │   ├── common.ts          //通用类型接口
 │   │   └── theme.ts           //系统主题配置相关类型接口
 │   ├── layouts                //布局组件
-│   │   ├── BasicLayout        //基本布局组件(包含全局头部、侧边栏、底部等)
-│   │   └── BlankLayout        //空白布局组件
+│   │   ├── BasicLayout        //基本布局(包含全局头部、侧边栏、底部等公共部分)
+│   │   ├── BlankLayout        //空白布局组件(单个页面)
+│   │   └── RouterViewLayout   //路由组件(用于多级路由之间的桥接)
 │   ├── plugins                //插件
 │   │   └── dark-mode.ts       //windicss暗黑模式插件
 │   ├── router                 //vue路由
-│   │   ├── cache.ts           //缓存的路由
-│   │   ├── components.ts      //缓存的路由对应的组件
-│   │   ├── helpers.ts         //工具函数
-│   │   ├── menus.ts           //菜单
-│   │   ├── permission.ts      //路由守卫相关函数
-│   │   └── routes.ts          //声明的路由
+│   │   ├── modules            //路由页面(按模块划分)
+│   │   ├── permission         //路由权限(路由守卫)
+│   │   ├── routes         		 //声明的路由
+│   │   └── setup              //路由挂载函数
 │   ├── service                //网络请求
-│   │   ├── api                //请求接口
+│   │   ├── api                //接口api
 │   │   ├── middleware         //请求结果的处理中间件
-│   │   ├── request            //封装的请求函数
-│   │   └── utils              //请求相关工具函数
-│   ├── settings               //项目初始配置
+│   │   └── request            //封装的请求函数
+│   ├── settings               //项目静态配置
+│   │   ├── constant           //常量配置
 │   │   └── theme.ts           //项目主题初始配置
 │   ├── store                  //状态管理
 │   │   └── modules            //状态管理划分的模块
 │   ├── styles                 //样式
+│   │   ├── css                //css
+│   │   └── scss               //scss
 │   ├── typings                //TS类型声明文件(*.d.ts)
 │   ├── utils                  //全局工具函数
-│   │   ├── auth
-│   │   ├── common
-│   │   ├── package
-│   │   ├── router
-│   │   └── storage
+│   │   ├── auth               //用户鉴权
+│   │   ├── common             //通用工具函数
+│   │   ├── package            //npm依赖
+│   │   ├── router             //路由
+│   │   ├── request            //请求工具函数
+│   │   └── storage            //存储
 │   ├── views                  //页面
 │   │   ├── about
 │   │   ├── component
 │   │   ├── dashboard
 │   │   ├── document
 │   │   ├── multi-menu
-│   │   └── system
+│   │   └── system             //系统内置页面：登录、异常页等
 │   ├── App.vue                //vue文件入口
 │   ├── AppProvider.vue        //配置naive UI的vue文件(国际化,loadingBar、message等组件)
 │   └── main.ts                //项目入口ts文件
@@ -118,7 +123,7 @@ soybean-admin
 ├── .prettierrc.js             //prettier代码格式插件配置
 ├── commitlint.config.js       //commitlint提交规范插件配置
 ├── index.html
-├── package.json
+├── package.json               //npm依赖描述文件
 ├── pnpm-lock.yaml             //npm包管理器pnpm依赖锁定文件
 ├── README.md                  //项目介绍文档
 ├── tsconfig.json              //TS配置