📝 docs: Add documentation

This commit is contained in:
web@ppanel
2025-12-11 03:29:07 +00:00
parent 50e695a1bb
commit 99e7f6062d
135 changed files with 79115 additions and 8 deletions
+144
View File
@@ -0,0 +1,144 @@
<div v-pre>
# 文档管理
创建和管理帮助文档,支持Markdown格式和标签分类。
## 表格列说明
### 显示 (Show)
开关按钮,控制文档是否在前台显示。
### 标题 (Title)
文档标题。
### 标签 (Tags)
文档分类标签,多个标签用逗号分隔。
### 更新时间 (Updated At)
最后更新时间。
## 表格操作
### 编辑
打开侧边抽屉表单修改文档。
### 删除
删除文档(需确认),不可恢复。
### 批量删除
选中多个文档后批量删除。
## 文档表单
### 标题 (必填)
文档标题。
### 标签 (必填)
文档分类标签,支持多个标签:
- 常用标签: 新手指南、使用教程、常见问题、技术支持
- 输入标签按回车添加
- 点击标签删除
### 内容 (必填)
文档正文,支持Markdown格式:
- 标题: # ## ### ####
- 粗体: **文字**
- 斜体: *文字*
- 代码块: ```语言
- 图片: ![alt](url)
- 链接: [文字](url)
- 列表: - 或 1.
- 引用: >
- 表格: | 列1 | 列2 |
## 筛选功能
### 关键词搜索
输入标题搜索文档。
### 标签筛选
输入标签查找对应分类文档。
## 使用场景
### 场景一: 创建新手指南
**表单配置**:
- 标题: 快速入门指南
- 标签: 新手指南, 使用教程
- 内容:
```markdown
# 快速入门指南
## 1. 注册账号
访问网站注册...
## 2. 购买套餐
进入订阅页面...
## 3. 下载客户端
支持的平台:
- Windows
- macOS
- Android
- iOS
```
- 显示: 开启
### 场景二: 创建FAQ
**表单配置**:
- 标题: 常见问题解答
- 标签: 常见问题, FAQ
- 内容:
```markdown
# 常见问题
## 如何重置密码?
答: 点击登录页面的"忘记密码"...
## 如何查看流量使用?
答: 登录后在个人中心查看...
## 订阅过期后怎么办?
答: 可以续费或购买新套餐...
```
- 显示: 开启
### 场景三: 创建平台教程
**表单配置**:
- 标题: Windows客户端使用教程
- 标签: 使用教程, Windows
- 内容:
```markdown
# Windows客户端教程
## 下载安装
1. 下载客户端
2. 运行安装程序
3. 完成安装
## 配置订阅
1. 复制订阅链接
2. 打开客户端
3. 导入订阅
## 连接服务
选择节点后点击连接即可
```
- 显示: 开启
## 重要提示
1. **Markdown支持**: 内容支持完整Markdown语法
2. **标签管理**: 合理使用标签便于用户查找
3. **显示控制**: 可先创建后再开启显示
4. **图片链接**: 图片使用外链地址
5. **代码高亮**: 代码块支持语法高亮
6. **批量操作**: 可批量删除过时文档
7. **搜索优化**: 标题和标签会被搜索索引
8. **更新提示**: 修改后更新时间会变化
</div>
+103
View File
@@ -0,0 +1,103 @@
<div v-pre>
# 工单管理
查看和处理用户提交的工单,支持回复和关闭工单。
## 表格列说明
### 标题 (Title)
工单标题。
### 用户 (User)
提交工单的用户。
### 状态 (Status)
工单当前状态(带颜色指示器):
- **待跟进** (红色) - 新提交,等待管理员处理
- **待回复** (黄色) - 管理员已回复,等待用户
- **已解决** (绿色) - 问题已解决
- **已关闭** (灰色) - 工单已关闭
### 更新时间 (Updated At)
最后更新时间。
## 表格操作
### 回复 (Reply)
打开工单对话抽屉:
- 查看工单完整对话
- 输入回复内容
- 发送回复后状态变为"待回复"
### 关闭 (Close)
关闭工单(需确认):
- 状态变为"已关闭"
- 关闭后无法再操作
- 用户可以再次查看
### 查看 (Check)
查看已关闭工单的对话记录(只读)。
## 工单对话
打开工单后显示对话界面:
**对话消息**:
- 工单描述(用户首条消息)
- 所有跟进记录
- 显示时间戳
- 区分用户/管理员消息
**回复工单**:
1. 在底部输入框输入回复
2. 点击发送按钮
3. 消息立即显示
4. 状态自动更新为"待回复"
**自动刷新**:
- 每5秒自动刷新对话
- 获取最新消息
## 筛选功能
### 状态筛选
选择"已关闭"查看关闭的工单。
## 使用场景
### 场景一: 处理新工单
1. 查看"待跟进"状态工单
2. 点击"回复"按钮
3. 阅读用户问题
4. 输入解决方案
5. 发送回复
6. 用户收到通知
### 场景二: 解决问题后关闭
1. 打开工单对话
2. 确认问题已解决
3. 点击"关闭"按钮
4. 确认关闭操作
5. 工单标记为已关闭
### 场景三: 多轮对话
1. 打开工单
2. 查看历史对话
3. 回复新消息
4. 持续跟进直到解决
## 重要提示
1. **及时回复**: 待跟进工单应尽快处理
2. **对话记录**: 所有消息永久保存
3. **自动刷新**: 对话每5秒自动更新
4. **关闭限制**: 关闭后无法再回复
5. **状态变化**: 回复后自动变为"待回复"
6. **用户通知**: 回复后用户会收到通知
7. **查看已关闭**: 已关闭工单可以查看但不能回复
</div>
+146
View File
@@ -0,0 +1,146 @@
<div v-pre>
# 用户管理
管理系统中的所有用户,包括用户信息编辑、订阅管理、余额管理等功能。
## 表格列说明
### 启用 (Enable)
开关按钮,控制用户账号是否可用。禁用后用户无法登录。
### ID
用户唯一标识ID。
### 用户名 (Username)
显示认证方式(EMAIL/GITHUB等)和认证标识(邮箱/用户名)。认证标识后有勾标记表示已验证。
### 余额 (Balance)
用户账户余额。
### 赠送金额 (Gift Amount)
系统赠送的金额。
### 佣金 (Commission)
用户通过邀请获得的佣金。
### 邀请码 (Invite Code)
用户的专属邀请码。
### 推荐人 (Referer)
邀请该用户注册的推荐人。
### 注册时间 (Created At)
用户注册时间。
## 表格操作
### 编辑 (Profile)
打开用户资料侧边抽屉,包含三个标签页:
**基础信息 (Basic Info)**:
- 启用状态
- 余额
- 赠送金额
- 佣金
- 邀请码
- 推荐人ID
**通知设置 (Notify Settings)**:
- 余额变动通知
- 登录通知
- 订阅通知
- 交易通知
**认证方式 (Auth Methods)**:
- 查看和管理用户登录方式
- 邮箱、GitHub等
### 订阅 (Subscription)
打开订阅管理侧边抽屉,查看和管理用户订阅:
- 订阅列表
- 订阅状态
- 到期时间
- 流量使用
- 操作订阅
### 删除
删除用户(需确认),不可恢复。
### 更多 (More)
下拉菜单,快速跳转到:
- 订单列表
- 登录日志
- 余额日志
- 佣金日志
- 赠送日志
## 筛选功能
### 订阅筛选
选择产品套餐,查看购买该套餐的用户。
### 关键词搜索
输入邮箱、用户名等搜索用户。
### 用户ID筛选
直接输入用户ID精确查找。
### 订阅ID筛选
输入订阅ID查找对应用户。
## 创建用户
点击"创建"按钮打开表单:
**必填字段**:
- 认证类型: EMAIL/GITHUB等
- 认证标识: 邮箱地址或用户名
- 密码: 用户登录密码
**可选字段**:
- 余额: 初始余额
- 推荐人ID: 绑定推荐关系
## 使用场景
### 场景一: 禁用违规用户
1. 找到目标用户
2. 关闭"启用"开关
3. 用户立即无法登录
### 场景二: 充值用户余额
1. 点击"编辑"按钮
2. 进入"基础信息"标签
3. 修改余额金额
4. 保存更改
### 场景三: 查看用户订阅
1. 点击"订阅"按钮
2. 查看用户所有订阅
3. 可操作订阅(续期、重置流量等)
### 场景四: 追踪用户行为
1. 点击"更多"按钮
2. 选择对应日志:
- 登录日志: 查看登录记录
- 余额日志: 查看余额变动
- 佣金日志: 查看佣金收益
- 赠送日志: 查看系统赠送
## 重要提示
1. **启用控制**: 禁用用户会立即踢出登录
2. **余额修改**: 直接修改余额,注意金额单位
3. **删除用户**: 操作不可恢复,删除前确认
4. **订阅管理**: 可以在用户订阅页面直接操作
5. **日志追踪**: 通过"更多"菜单快速查看用户各类日志
6. **推荐关系**: 创建用户时可指定推荐人
7. **批量操作**: 目前不支持批量操作
8. **邀请码**: 每个用户有唯一邀请码
</div>