diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 06b087b..6eea065 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -10,5 +10,17 @@ - [9. 目录结构(TODO)](manual/start/directory-structure) - [10. 常见问题](manual/start/faq) +- **二、使用说明** + - [1. 开始使用(撰写中)](manual/instructions/start-using) + +- **三、接口文档** + - [1. 简介](manual/api/introduction) + - [2. 全局状态码](manual/api/status-code) + - [【加sidebar!】3. 前端Api接口(撰写中)](manual/api/frontend-interface) + - [4. 后端Api接口(待完善)](manual/api/backend-interface) + - [5. 接口模板](manual/api/interface-template) + - [1. 简介](manual/api/introduction) + + - [TODO](manual/todo) - [test](manual/test) \ No newline at end of file diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/5. 词书/.keep b/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/5. 词书/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/6. 通知/.keep b/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/6. 通知/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/manual/3. 接口文档/5. 文档模板/.keep b/docs/manual/3. 接口文档/5. 文档模板/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/manual/4. 应用开发文档/.keep b/docs/manual/4. 应用开发文档/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/manual/5. 关于/.keep b/docs/manual/5. 关于/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/manual/6. 【清单 ToDo】/.keep b/docs/manual/6. 【清单 ToDo】/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/manual/2. 使用说明/.keep b/docs/manual/api/5. 文档模板/.keep similarity index 100% rename from docs/manual/2. 使用说明/.keep rename to docs/manual/api/5. 文档模板/.keep diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/0. 概述/通用参数(待完成).md b/docs/manual/api/backend-interface.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/0. 概述/通用参数(待完成).md rename to docs/manual/api/backend-interface.md diff --git a/docs/manual/3. 接口文档/.keep b/docs/manual/api/frontend-interface/.keep similarity index 100% rename from docs/manual/3. 接口文档/.keep rename to docs/manual/api/frontend-interface/.keep diff --git a/docs/manual/3. 接口文档/4. 后端Api接口(待完善).md b/docs/manual/api/frontend-interface/0. 概述/通用参数(待完成).md similarity index 100% rename from docs/manual/3. 接口文档/4. 后端Api接口(待完善).md rename to docs/manual/api/frontend-interface/0. 概述/通用参数(待完成).md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/.keep b/docs/manual/api/frontend-interface/1. 站点/.keep similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/.keep rename to docs/manual/api/frontend-interface/1. 站点/.keep diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/1. 站点/上传logo(待完善).md b/docs/manual/api/frontend-interface/1. 站点/上传logo(待完善).md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/1. 站点/上传logo(待完善).md rename to docs/manual/api/frontend-interface/1. 站点/上传logo(待完善).md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/1. 站点/检查更新(待完善).md b/docs/manual/api/frontend-interface/1. 站点/检查更新(待完善).md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/1. 站点/检查更新(待完善).md rename to docs/manual/api/frontend-interface/1. 站点/检查更新(待完善).md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/1. 站点/站点基本信息(待完善).md b/docs/manual/api/frontend-interface/1. 站点/站点基本信息(待完善).md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/1. 站点/站点基本信息(待完善).md rename to docs/manual/api/frontend-interface/1. 站点/站点基本信息(待完善).md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/0. 概述/.keep b/docs/manual/api/frontend-interface/2. 管理员/.keep similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/0. 概述/.keep rename to docs/manual/api/frontend-interface/2. 管理员/.keep diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/2. 管理员/用户注册(待完善).md b/docs/manual/api/frontend-interface/2. 管理员/用户注册(待完善).md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/2. 管理员/用户注册(待完善).md rename to docs/manual/api/frontend-interface/2. 管理员/用户注册(待完善).md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/2. 管理员/用户登录(待完善).md b/docs/manual/api/frontend-interface/2. 管理员/用户登录(待完善).md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/2. 管理员/用户登录(待完善).md rename to docs/manual/api/frontend-interface/2. 管理员/用户登录(待完善).md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/2. 管理员/(待完善).md b/docs/manual/api/frontend-interface/2. 管理员/(待完善).md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/2. 管理员/(待完善).md rename to docs/manual/api/frontend-interface/2. 管理员/(待完善).md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/1. 站点/.keep b/docs/manual/api/frontend-interface/3. 用户/.keep similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/1. 站点/.keep rename to docs/manual/api/frontend-interface/3. 用户/.keep diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/3. 用户/用户注册(待完善).md b/docs/manual/api/frontend-interface/3. 用户/用户注册(待完善).md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/3. 用户/用户注册(待完善).md rename to docs/manual/api/frontend-interface/3. 用户/用户注册(待完善).md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/3. 用户/用户登录(待完善).md b/docs/manual/api/frontend-interface/3. 用户/用户登录(待完善).md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/3. 用户/用户登录(待完善).md rename to docs/manual/api/frontend-interface/3. 用户/用户登录(待完善).md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/3. 用户/(待完善).md b/docs/manual/api/frontend-interface/3. 用户/(待完善).md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/3. 用户/(待完善).md rename to docs/manual/api/frontend-interface/3. 用户/(待完善).md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/2. 管理员/.keep b/docs/manual/api/frontend-interface/4. 单词/.keep similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/2. 管理员/.keep rename to docs/manual/api/frontend-interface/4. 单词/.keep diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/3. 用户/.keep b/docs/manual/api/frontend-interface/5. 词书/.keep similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/3. 用户/.keep rename to docs/manual/api/frontend-interface/5. 词书/.keep diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/4. 单词/.keep b/docs/manual/api/frontend-interface/6. 通知/.keep similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/4. 单词/.keep rename to docs/manual/api/frontend-interface/6. 通知/.keep diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/用户类 - 修改账户信息.md b/docs/manual/api/frontend-interface/用户类 - 修改账户信息.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/用户类 - 修改账户信息.md rename to docs/manual/api/frontend-interface/用户类 - 修改账户信息.md diff --git a/docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/用户类 - 用户登录、注销、获取状态.md b/docs/manual/api/frontend-interface/用户类 - 用户登录、注销、获取状态.md similarity index 100% rename from docs/manual/3. 接口文档/3. 前端Api接口(撰写中)/用户类 - 用户登录、注销、获取状态.md rename to docs/manual/api/frontend-interface/用户类 - 用户登录、注销、获取状态.md diff --git a/docs/manual/3. 接口文档/5. 文档模板/前端Api接口.md b/docs/manual/api/interface-template.md similarity index 87% rename from docs/manual/3. 接口文档/5. 文档模板/前端Api接口.md rename to docs/manual/api/interface-template.md index 2d87f34..afa1fb8 100644 --- a/docs/manual/3. 接口文档/5. 文档模板/前端Api接口.md +++ b/docs/manual/api/interface-template.md @@ -1,4 +1,7 @@ - +# 前端接口文档模板 + + + #### 【XXX】 这里填写接口简介。 @@ -72,4 +75,12 @@ xxxxxx - \ No newline at end of file + + +---------- + +# 后端接口文档模板 + + + + diff --git a/docs/manual/3. 接口文档/1. 简介.md b/docs/manual/api/introduction.md similarity index 100% rename from docs/manual/3. 接口文档/1. 简介.md rename to docs/manual/api/introduction.md diff --git a/docs/manual/3. 接口文档/2. 全局状态码.md b/docs/manual/api/status-code.md similarity index 100% rename from docs/manual/3. 接口文档/2. 全局状态码.md rename to docs/manual/api/status-code.md diff --git a/docs/manual/2. 使用说明/开始使用(撰写中).md b/docs/manual/instructions/start-using.md similarity index 100% rename from docs/manual/2. 使用说明/开始使用(撰写中).md rename to docs/manual/instructions/start-using.md diff --git a/docs/manual/start/.keep b/docs/manual/start/.keep deleted file mode 100644 index e69de29..0000000