📝 docs: Add documentation
This commit is contained in:
web@ppanel
@@ -0,0 +1,144 @@
|
||||
<div v-pre>
|
||||
|
||||
# Document Management
|
||||
|
||||
Create and manage help documents with Markdown format and tag classification.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Show
|
||||
Switch button to control whether document displays on frontend.
|
||||
|
||||
### Title
|
||||
Document title.
|
||||
|
||||
### Tags
|
||||
Document classification tags, multiple tags separated by commas.
|
||||
|
||||
### Updated At
|
||||
Last update time.
|
||||
|
||||
## Table Operations
|
||||
|
||||
### Edit
|
||||
Opens side drawer form to modify document.
|
||||
|
||||
### Delete
|
||||
Deletes document (requires confirmation), cannot be recovered.
|
||||
|
||||
### Batch Delete
|
||||
Deletes multiple selected documents.
|
||||
|
||||
## Document Form
|
||||
|
||||
### Title (Required)
|
||||
Document title.
|
||||
|
||||
### Tags (Required)
|
||||
Document classification tags, supports multiple tags:
|
||||
- Common tags: Beginner Guide, Tutorial, FAQ, Technical Support
|
||||
- Press Enter after inputting tag to add
|
||||
- Click tag to delete
|
||||
|
||||
### Content (Required)
|
||||
Document body, supports Markdown format:
|
||||
- Headings: # ## ### ####
|
||||
- Bold: **text**
|
||||
- Italic: *text*
|
||||
- Code blocks: ```language
|
||||
- Images: 
|
||||
- Links: [text](url)
|
||||
- Lists: - or 1.
|
||||
- Quotes: >
|
||||
- Tables: | Col1 | Col2 |
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Keyword Search
|
||||
Search documents by title.
|
||||
|
||||
### Tag Filter
|
||||
Input tag to find documents in that category.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: Create Beginner Guide
|
||||
|
||||
**Form Config**:
|
||||
- Title: Quick Start Guide
|
||||
- Tags: Beginner Guide, Tutorial
|
||||
- Content:
|
||||
```markdown
|
||||
# Quick Start Guide
|
||||
|
||||
## 1. Register Account
|
||||
Visit website to register...
|
||||
|
||||
## 2. Purchase Plan
|
||||
Go to subscribe page...
|
||||
|
||||
## 3. Download Client
|
||||
Supported platforms:
|
||||
- Windows
|
||||
- macOS
|
||||
- Android
|
||||
- iOS
|
||||
```
|
||||
- Show: On
|
||||
|
||||
### Scenario 2: Create FAQ
|
||||
|
||||
**Form Config**:
|
||||
- Title: Frequently Asked Questions
|
||||
- Tags: FAQ, Common Issues
|
||||
- Content:
|
||||
```markdown
|
||||
# FAQ
|
||||
|
||||
## How to reset password?
|
||||
A: Click "Forgot Password" on login page...
|
||||
|
||||
## How to check traffic usage?
|
||||
A: View in profile after login...
|
||||
|
||||
## What to do after subscription expires?
|
||||
A: Can renew or purchase new plan...
|
||||
```
|
||||
- Show: On
|
||||
|
||||
### Scenario 3: Create Platform Tutorial
|
||||
|
||||
**Form Config**:
|
||||
- Title: Windows Client Tutorial
|
||||
- Tags: Tutorial, Windows
|
||||
- Content:
|
||||
```markdown
|
||||
# Windows Client Tutorial
|
||||
|
||||
## Download & Install
|
||||
1. Download client
|
||||
2. Run installer
|
||||
3. Complete installation
|
||||
|
||||
## Configure Subscription
|
||||
1. Copy subscription link
|
||||
2. Open client
|
||||
3. Import subscription
|
||||
|
||||
## Connect Service
|
||||
Select node and click connect
|
||||
```
|
||||
- Show: On
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Markdown Support**: Content supports full Markdown syntax
|
||||
2. **Tag Management**: Proper tags help users find content
|
||||
3. **Display Control**: Can create first, enable display later
|
||||
4. **Image Links**: Use external URLs for images
|
||||
5. **Code Highlighting**: Code blocks support syntax highlighting
|
||||
6. **Batch Operations**: Can batch delete outdated documents
|
||||
7. **Search Optimization**: Titles and tags are search indexed
|
||||
8. **Update Indicator**: Update time changes after modification
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,103 @@
|
||||
<div v-pre>
|
||||
|
||||
# Ticket Management
|
||||
|
||||
View and handle user-submitted tickets with reply and close functions.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Title
|
||||
Ticket title.
|
||||
|
||||
### User
|
||||
User who submitted the ticket.
|
||||
|
||||
### Status
|
||||
Current ticket status (with color indicator):
|
||||
- **Pending Follow-up** (Red) - Newly submitted, awaiting admin
|
||||
- **Pending Reply** (Yellow) - Admin replied, awaiting user
|
||||
- **Resolved** (Green) - Issue resolved
|
||||
- **Closed** (Gray) - Ticket closed
|
||||
|
||||
### Updated At
|
||||
Last update time.
|
||||
|
||||
## Table Operations
|
||||
|
||||
### Reply
|
||||
Opens ticket conversation drawer:
|
||||
- View complete ticket conversation
|
||||
- Input reply content
|
||||
- After sending, status changes to "Pending Reply"
|
||||
|
||||
### Close
|
||||
Closes ticket (requires confirmation):
|
||||
- Status becomes "Closed"
|
||||
- Cannot operate after closure
|
||||
- User can still view
|
||||
|
||||
### Check
|
||||
View closed ticket conversation (read-only).
|
||||
|
||||
## Ticket Conversation
|
||||
|
||||
After opening ticket, shows conversation interface:
|
||||
|
||||
**Conversation Messages**:
|
||||
- Ticket description (user's first message)
|
||||
- All follow-up records
|
||||
- Shows timestamps
|
||||
- Distinguishes user/admin messages
|
||||
|
||||
**Reply Ticket**:
|
||||
1. Input reply in bottom text box
|
||||
2. Click send button
|
||||
3. Message displays immediately
|
||||
4. Status auto-updates to "Pending Reply"
|
||||
|
||||
**Auto Refresh**:
|
||||
- Auto-refreshes every 5 seconds
|
||||
- Gets latest messages
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Status Filter
|
||||
Select "Closed" to view closed tickets.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: Handle New Ticket
|
||||
|
||||
1. View "Pending Follow-up" tickets
|
||||
2. Click "Reply" button
|
||||
3. Read user's question
|
||||
4. Input solution
|
||||
5. Send reply
|
||||
6. User receives notification
|
||||
|
||||
### Scenario 2: Close After Resolution
|
||||
|
||||
1. Open ticket conversation
|
||||
2. Confirm issue resolved
|
||||
3. Click "Close" button
|
||||
4. Confirm close operation
|
||||
5. Ticket marked as closed
|
||||
|
||||
### Scenario 3: Multiple Rounds of Conversation
|
||||
|
||||
1. Open ticket
|
||||
2. View conversation history
|
||||
3. Reply with new message
|
||||
4. Continue following up until resolved
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Timely Reply**: Pending tickets should be handled promptly
|
||||
2. **Conversation Records**: All messages permanently saved
|
||||
3. **Auto Refresh**: Conversation auto-updates every 5 seconds
|
||||
4. **Close Restriction**: Cannot reply after closure
|
||||
5. **Status Change**: Auto-changes to "Pending Reply" after replying
|
||||
6. **User Notification**: User receives notification after reply
|
||||
7. **View Closed**: Closed tickets viewable but not replyable
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,146 @@
|
||||
<div v-pre>
|
||||
|
||||
# User Management
|
||||
|
||||
Manage all users in the system, including user information editing, subscription management, balance management, and more.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Enable
|
||||
Switch button to control whether user account is active. Disabled users cannot login.
|
||||
|
||||
### ID
|
||||
User unique identifier ID.
|
||||
|
||||
### Username
|
||||
Shows authentication method (EMAIL/GITHUB etc) and auth identifier (email/username). Checkmark after identifier indicates verified.
|
||||
|
||||
### Balance
|
||||
User account balance.
|
||||
|
||||
### Gift Amount
|
||||
Amount gifted by system.
|
||||
|
||||
### Commission
|
||||
Commission earned through user referrals.
|
||||
|
||||
### Invite Code
|
||||
User's exclusive invite code.
|
||||
|
||||
### Referer
|
||||
Referrer who invited this user to register.
|
||||
|
||||
### Created At
|
||||
User registration time.
|
||||
|
||||
## Table Operations
|
||||
|
||||
### Edit (Profile)
|
||||
Opens user profile side drawer with three tabs:
|
||||
|
||||
**Basic Info**:
|
||||
- Enable status
|
||||
- Balance
|
||||
- Gift amount
|
||||
- Commission
|
||||
- Invite code
|
||||
- Referer ID
|
||||
|
||||
**Notify Settings**:
|
||||
- Balance change notification
|
||||
- Login notification
|
||||
- Subscription notification
|
||||
- Trade notification
|
||||
|
||||
**Auth Methods**:
|
||||
- View and manage user login methods
|
||||
- Email, GitHub, etc.
|
||||
|
||||
### Subscription
|
||||
Opens subscription management side drawer to view and manage user subscriptions:
|
||||
- Subscription list
|
||||
- Subscription status
|
||||
- Expiry time
|
||||
- Traffic usage
|
||||
- Subscription operations
|
||||
|
||||
### Delete
|
||||
Deletes user (requires confirmation), cannot be recovered.
|
||||
|
||||
### More
|
||||
Dropdown menu for quick navigation to:
|
||||
- Order list
|
||||
- Login logs
|
||||
- Balance logs
|
||||
- Commission logs
|
||||
- Gift logs
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Subscription Filter
|
||||
Select product plan to view users who purchased that plan.
|
||||
|
||||
### Keyword Search
|
||||
Search users by email, username, etc.
|
||||
|
||||
### User ID Filter
|
||||
Direct input of user ID for precise search.
|
||||
|
||||
### Subscription ID Filter
|
||||
Input subscription ID to find corresponding user.
|
||||
|
||||
## Create User
|
||||
|
||||
Click "Create" button to open form:
|
||||
|
||||
**Required Fields**:
|
||||
- Auth Type: EMAIL/GITHUB etc
|
||||
- Auth Identifier: Email address or username
|
||||
- Password: User login password
|
||||
|
||||
**Optional Fields**:
|
||||
- Balance: Initial balance
|
||||
- Referer ID: Bind referral relationship
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: Disable Violating User
|
||||
|
||||
1. Find target user
|
||||
2. Turn off "Enable" switch
|
||||
3. User immediately cannot login
|
||||
|
||||
### Scenario 2: Top Up User Balance
|
||||
|
||||
1. Click "Edit" button
|
||||
2. Enter "Basic Info" tab
|
||||
3. Modify balance amount
|
||||
4. Save changes
|
||||
|
||||
### Scenario 3: View User Subscriptions
|
||||
|
||||
1. Click "Subscription" button
|
||||
2. View all user subscriptions
|
||||
3. Can operate subscriptions (renew, reset traffic, etc)
|
||||
|
||||
### Scenario 4: Track User Behavior
|
||||
|
||||
1. Click "More" button
|
||||
2. Select corresponding log:
|
||||
- Login logs: View login records
|
||||
- Balance logs: View balance changes
|
||||
- Commission logs: View commission earnings
|
||||
- Gift logs: View system gifts
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Enable Control**: Disabling user immediately kicks them out
|
||||
2. **Balance Modification**: Direct balance modification, watch amount units
|
||||
3. **Delete User**: Operation irreversible, confirm before deletion
|
||||
4. **Subscription Management**: Can operate directly in user subscription page
|
||||
5. **Log Tracking**: Quickly view various user logs through "More" menu
|
||||
6. **Referral Relationship**: Can specify referrer when creating user
|
||||
7. **Batch Operations**: Currently not supported
|
||||
8. **Invite Code**: Each user has unique invite code
|
||||
|
||||
</div>
|
||||
Reference in New Issue
Block a user