From ec53bf80844658cbd0093a9a2393577486e85d27 Mon Sep 17 00:00:00 2001 From: Mintnoii Date: Sun, 17 Nov 2024 20:54:28 +0800 Subject: [PATCH] docs: optimize the introduction in both Chinese and English (#4913) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 优化简介中文文档 1. 优化文案及病句 2. 统一格式 * Optimize the introduction English document 1. Optimize copywriting and sentences 2. Uniform format --- docs/src/en/guide/introduction/vben.md | 10 ++++------ docs/src/guide/introduction/vben.md | 12 ++++++------ 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/docs/src/en/guide/introduction/vben.md b/docs/src/en/guide/introduction/vben.md index caed4d3b..8a2ba1cc 100644 --- a/docs/src/en/guide/introduction/vben.md +++ b/docs/src/en/guide/introduction/vben.md @@ -18,7 +18,7 @@ - **Permission Validation**: Comprehensive permission validation solutions, including button-level permission control. - **Multi-Theme**: Built-in multiple theme configurations & dark mode to meet personalized needs. - **Dynamic Menu**: Supports dynamic menus that can display based on permissions. -- **Mock Data**: High-performance local Mock data solution based on Nitro. +- **Mock Data**: High-performance local Mock data solution based on `Nitro`. - **Rich Components**: Provides a wide range of components to meet most business needs. - **Standardization**: Code quality is ensured with tools like `ESLint`, `Prettier`, `Stylelint`, `Publint`, and `CSpell`. - **Engineering**: Development efficiency is improved with tools like `Pnpm Monorepo`, `TurboRepo`, and `Changeset`. @@ -26,9 +26,9 @@ ## Browser Support -**Local development** is recommended using the **latest version of Chrome**. **Versions below Chrome 80 are not supported**. +- **Local development** is recommended using the **latest version of Chrome**. **Versions below Chrome 80 are not supported**. -**Production environment** supports modern browsers, IE is not supported. +- **Production environment** supports modern browsers, IE is not supported. | [IE](http://godban.github.io/browsers-support-badges/)IE | [ Edge](http://godban.github.io/browsers-support-badges/)Edge | [Firefox](http://godban.github.io/browsers-support-badges/)Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)Chrome | [Safari](http://godban.github.io/browsers-support-badges/)Safari | | :-: | :-: | :-: | :-: | :-: | @@ -37,12 +37,10 @@ ## Contribution - [Vben Admin](https://github.com/vbenjs/vue-vben-admin) is still being actively updated. Contributions are welcome to help maintain and improve the project, aiming to create a better mid- to backend solution. -- If you wish to join us, you can provide suggestions or submit pull requests. We will invite you to join based on your activity. +- If you wish to join us, you can start by contributing in the following ways, and we will invite you to join based on your activity. ::: info Join Us -If you wish to join us, you can start by contributing in the following ways, and we will invite you to join based on your activity: - - Regularly submit `PRs`. - Provide valuable suggestions. - Participate in discussions and help resolve some `issues`. diff --git a/docs/src/guide/introduction/vben.md b/docs/src/guide/introduction/vben.md index 90dae052..a4a5f975 100644 --- a/docs/src/guide/introduction/vben.md +++ b/docs/src/guide/introduction/vben.md @@ -18,7 +18,7 @@ - **权限验证**：完善的权限验证方案，按钮级别权限控制。 - **多主题**：内置多种主题配置和黑暗模式，满足个性化需求。 - **动态菜单**：支持动态菜单，可以根据权限配置显示菜单。 -- **Mock 数据**：基于 Nitro 的本地高性能 Mock 数据方案。 +- **Mock 数据**：基于 `Nitro` 的本地高性能 Mock 数据方案。 - **组件丰富**：提供了丰富的组件，可以满足大部分的业务需求。 - **规范**：代码规范，使用 `ESLint`、`Prettier`、`Stylelint`、`Publint`、`CSpell` 等工具保证代码质量。 - **工程化**：使用 `Pnpm Monorepo`、`TurboRepo`、`Changeset` 等工具，提高开发效率。 @@ -26,9 +26,9 @@ ## 浏览器支持 -**本地开发**推荐使用`Chrome 最新版`浏览器，**不支持**`Chrome 80`以下版本。 +- **本地开发**推荐使用`Chrome 最新版`浏览器，**不支持**`Chrome 80`以下版本。 -**生产环境**支持现代浏览器，不支持 IE。 +- **生产环境**支持现代浏览器，不支持 IE。 | [IE](http://godban.github.io/browsers-support-badges/)IE | [ Edge](http://godban.github.io/browsers-support-badges/)Edge | [Firefox](http://godban.github.io/browsers-support-badges/)Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)Chrome | [Safari](http://godban.github.io/browsers-support-badges/)Safari | | :-: | :-: | :-: | :-: | :-: | @@ -37,13 +37,13 @@ ## 贡献 - [Vben Admin](https://github.com/vbenjs/vue-vben-admin) 还在持续更新中，本项目欢迎您的参与，共同维护，逐步完善，打造更好的中后台解决方案。 -- 如果你想加入我们，可以提供有价值的建议或者参与讨论，协助解决 issue，- 如果你想加入我们，可以提供有价值的建议或者参与讨论，协助解决 issue，我们会根据你的活跃度邀请你加入。。 +- 如果你有兴趣加入我们，可以通过以下方式开始，我们会根据你的活跃度邀请你加入。 ::: info 加入我们 - 长期提交 `PR`。 -- 提供一些好的建议。 -- 参与讨论，帮助解决一些 `issue`。 +- 提供有价值的建议。 +- 参与讨论，帮助解决 `issue`。 - 共同维护文档。 :::