Commit 7f41c9d57acb2266d2e4eb4d3f8fb9e4127052ad
1 parent
5e541f09
chore: update README
Showing
1 changed file
with
26 additions
and
4 deletions
docs/zh/getting-started/quick-start.md
| ... | ... | @@ -2,15 +2,35 @@ |
| 2 | 2 | |
| 3 | 3 | [[toc]] |
| 4 | 4 | |
| 5 | -- 重要:关于此部分有疑惑,请在下面直接评论,或者到[社区](https://support.qq.com/products/93432/)讨论 | |
| 6 | -- 如果您已经熟悉并已经安装了 `Node`、`Yarn`,可以直接参照下面的命令,快速上手 | |
| 7 | -- 如果您不熟悉,请阅读下面的详细教程 | |
| 5 | +::: tip 开始前必读 | |
| 6 | +#### 共建文档 | |
| 7 | + - 发现任何拼写错误、阅读拗口(请直接评论 或 提issue) | |
| 8 | + - 细节缺失、任何一点可以改进的(请直接评论 或 提issue) | |
| 9 | + - 文档需要大家的Review | |
| 10 | + - 流畅、优雅、舒服的阅读体验需要您的建议 | |
| 11 | + | |
| 12 | +#### 关于提问(我的一些期待) | |
| 13 | + - 多读两遍:[提问的智慧](https://zhuanlan.zhihu.com/p/19779979) | |
| 14 | + - 遇到问题,请先尝试Google 搜索相关问题+解决方案 | |
| 15 | + - 如果多次尝试仍未解决、卡住了,及时提问 | |
| 16 | + - 提问的话,请提供: | |
| 17 | + - 上下文 + 基本信息:比如版本号、运行环境、自己做了哪些尝试 等 | |
| 18 | + - 换位思考 !!!! | |
| 19 | + | |
| 20 | +#### 其它 | |
| 21 | + - 重要:关于此部分有疑惑,请在下面直接评论,或者到[社区](https://support.qq.com/products/93432/)讨论 | |
| 22 | + - 如果您已经熟悉并已经安装了 `Node`、`Yarn`,可以直接参照下面的命令,快速上手 | |
| 23 | + - 如果您不熟悉,请阅读下面的详细教程 | |
| 24 | + - [安装常见问题汇总](https://github.com/ly525/luban-h5/issues/109) | |
| 25 | + | |
| 26 | +::: | |
| 27 | + | |
| 8 | 28 | |
| 9 | 29 | ## 技术栈(当前) |
| 10 | 30 | |
| 11 | 31 | ::: warning |
| 12 | 32 | - 推荐采用 Node LTS (v10 or V12) |
| 13 | -- 安装完成后, 如果遇到接口 403 问题,请看:[#_2-注意事项](#_2-注意事项) | |
| 33 | +- 安装完成后, 如果遇到接口 403 问题,请看:[常见问题](#常见问题) | |
| 14 | 34 | ::: |
| 15 | 35 | |
| 16 | 36 | ::: details Node、Yarn 等基础概念 |
| ... | ... | @@ -188,6 +208,8 @@ yarn dev |
| 188 | 208 | ::: |
| 189 | 209 | |
| 190 | 210 | ## 常见问题 |
| 211 | +> [安装常见问题汇总](https://github.com/ly525/luban-h5/issues/109) | |
| 212 | + | |
| 191 | 213 | ### 接口 `403 Forbidden` |
| 192 | 214 | ::: details 点击查看 403 解决方案 |
| 193 | 215 | - 本地开发,如果后端接口报错 403 Forbidden | ... | ... |