Skip to content

Commit

Permalink
docs(root): 新增文档快速开始、常见问题,更新文档主页
Browse files Browse the repository at this point in the history
  • Loading branch information
mintsweet committed Jul 2, 2019
1 parent 4f0382d commit 31ab1b7
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 22 deletions.
13 changes: 5 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@

`2019-xx-xx`

### mobile

- 初始化项目

### manage

- 初始化项目
Expand All @@ -28,16 +24,17 @@

初始化以下 API:

- 获取图形验证码
- 头像上传
- 注册
- 账户激活
- 登录
- 忘记密码
- 重置密码
- 获取当前用户信息
- 头像上传
- 更新个人信息
- 修改密码
- GitHub 登录
- 获取图形验证码
- 登录
- 获取当前用户信息
- 获取积分榜用户列表
- 根据ID获取用户信息
- 获取用户动态
Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center">
<a href="https://docs.mintsweet.cn">
<img width="200" src="./docs/_media/logo.svg" />
<img width="200" src="https://github.com/mintsweet/practice/raw/master/docs/_media/logo.svg" />
</a>
</p>

Expand All @@ -27,7 +27,7 @@

## 🔥 初衷

可能是因为现在的前端圈的技术太多了,很多人不知道从何入手,无所适从,所以我还是想做一个教你如何去写而不是理论的东西,毕竟做出东西才会有兴趣,理论也是可以补的
可能是因为现在的前端圈的技术太多了,很多人不知道从何入手,无所适从,所以我还是想做一个教你如何去写而不是理论的东西,毕竟做出东西才会有兴趣,毕竟理论也是可以补的


## 🌈 项目
Expand All @@ -36,12 +36,14 @@
- [PC客户端 client](./packages/client/README.md)
- [后台管理 manage](./packages/manage/README.md)

## ⚡ 其他
## 🔗 链接

如若你有任何问题或者想法都可以在`issue`中提出,欢迎 star!
- [文档](https://docs.mintsweet.cn)
- [快速入门](https://docs.mintsweet.cn/#/quick_start)
- [API](https://docs.mintsweet.cn/#/API)

**开源不易,且行且珍惜!!!**
## 🔨 其他

## 🔫 协议
如若你有任何问题或者想法都可以在`issue`中提出,欢迎 star!

[MIT](./LICENSE)
**开源不易,且行且珍惜!!!**
1 change: 1 addition & 0 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# FAQ 常见问题
4 changes: 3 additions & 1 deletion docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
- 快速入门

- [持续集成](ci.md)
- [快速开始](quick_start.md)
- [项目部署](deploy.md)

- 流程规范

- [代码规范](codespecification.md)
- [Git 使用规范](gitspecification.md)
- [持续集成](ci.md)

- 项目文档

Expand All @@ -17,5 +18,6 @@
- 其他

- [踩坑记录](problemrecord.md)
- [常见问题](FAQ.md)
- [API文档](API.md)
- [更新日志](CHANGELOG)
1 change: 1 addition & 0 deletions docs/quick_start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 快速开始
6 changes: 0 additions & 6 deletions packages/server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,3 @@
2. 执行 `npm install` 或者是 `yarn` 安装依赖
3. 执行 `npm start` 或者是 `yarn start`
4. 检查服务是否开始,浏览器访问 `http://localhost:3000/api` 是否有返回JSON。

## 常见问题(FAQ)

### 如何部署在服务器上

关于服务器部署,文档上有一篇专门的说明,[详见文档](https://docs.mintsweet.cn/#/deploy)

0 comments on commit 31ab1b7

Please sign in to comment.