Skip to content

Commit c031fad

Browse files
committed
docs: update bun install instructions and correct referral reward descriptions
- Add separate instructions for New Frontend (default) and Classic Frontend (classic) - Correct referral reward descriptions to reflect registration rewards and top-up rebates rather than consumption rebates
1 parent 0d104a9 commit c031fad

12 files changed

Lines changed: 203 additions & 57 deletions

File tree

content/docs/en/guide/feature-guide/admin/system-setting-advanced.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -602,8 +602,8 @@ Configure parameters related to platform operations.
602602
1. On the System Settings page, click the "Operation Settings" tab.
603603
2. Configure operation parameters:
604604
- **New User Initial Quota**: Initial Quota for newly registered users.
605-
- **Invitation Reward Quota**: Reward Quota for inviting new users to register.
606-
- **Rebate Ratio**: Rebate Ratio (%) for consumption by invited users.
605+
- **Invitation Reward Quota**: Reward Quota granted to the inviter upon successful registration of a referred user.
606+
- **Rebate Ratio**: Rebate Ratio (%) granted to the inviter when a referred user topups.
607607

608608
### Top-up Configuration
609609

content/docs/en/guide/feature-guide/user/topup.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,15 @@ Supports online payment and redemption codes to add quota to your account.
3838

3939
## Referral Rewards
4040

41-
Every account has a unique referral code. When someone you refer makes purchases, you earn reward quota.
41+
Every account has a unique referral code. When someone registers successfully using your referral code, you will earn referral rewards.
4242

43-
1. Find the "Referral" section on the top-up page or in Personal Settings, and copy your referral code
43+
### Get Referral Code
44+
45+
Find the "Referral" section on the top-up page or in Personal Settings, and copy your unique referral code.
4446

4547
![Referral code and rewards section](/assets/guide/feature-guide/topup-invite.png)
4648

47-
2. Share your referral code with others — they enter it when registering
48-
3. When referred users make purchases, your reward quota balance increases automatically
49-
4. Click "Transfer to Balance" to move reward quota into your main account balance for use
49+
### Referral Reward Mechanism
50+
51+
1. **Immediate Rebate upon Registration**: When a referred user registers successfully using your referral code, you (the inviter) will immediately receive an "Invitation Reward Quota" configured by the system (one-time credit).
52+
2. **Transfer to Main Balance**: Click the "Transfer to Balance" button to move your accumulated reward quota into your main account balance for use.

content/docs/en/installation/config-maintenance/system-update.mdx

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,18 @@ git pull
9595
# 编译后端
9696
go build -o new-api
9797

98-
# 更新并编译前端
99-
cd web
98+
# Update and build frontend (choose new or classic as needed, default is new)
99+
# New Frontend (default)
100+
cd web/default
100101
bun install
101102
bun run build
102-
cd ..
103+
cd ../..
104+
105+
# Classic Frontend (classic)
106+
# cd web/classic
107+
# bun install
108+
# bun run build
109+
# cd ../..
103110

104111
# 重启服务
105112
./new-api --port 3000
@@ -165,11 +172,18 @@ git checkout v1.x.x
165172
# 重新编译
166173
go build -o new-api
167174

168-
# 更新并编译前端
169-
cd web
175+
# Update and build frontend (choose new or classic as needed, default is new)
176+
# New Frontend (default)
177+
cd web/default
170178
bun install
171179
bun run build
172-
cd ..
180+
cd ../..
181+
182+
# Classic Frontend (classic)
183+
# cd web/classic
184+
# bun install
185+
# bun run build
186+
# cd ../..
173187

174188
# 重启服务
175189
./new-api --port 3000

content/docs/en/installation/deployment-methods/local-development.mdx

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,26 +105,61 @@ After installation, restart your terminal or run `source ~/.bashrc` (or `~/.zshr
105105

106106
### Install Frontend Dependencies
107107

108+
Depending on the frontend version you need to develop or compile, navigate to the corresponding directory to install dependencies and develop:
109+
110+
#### New Frontend (default)
111+
108112
```bash
109-
cd web
110-
bun install # Install frontend dependencies using bun
113+
cd web/default
114+
bun install # Install new frontend dependencies using bun
115+
```
116+
117+
#### Classic Frontend (classic)
118+
119+
```bash
120+
cd web/classic
121+
bun install # Install classic frontend dependencies using bun
111122
```
112123

113124
### Run Development Server
114125

126+
Choose a frontend version to run:
127+
128+
**New Frontend (default):**
129+
130+
```bash
131+
cd web/default
132+
bun run dev # Run new development server using bun
133+
```
134+
135+
**Classic Frontend (classic):**
136+
115137
```bash
116-
bun run dev # Run development server using bun
138+
cd web/classic
139+
bun run dev # Run classic development server using bun
117140
```
118141

119-
The frontend development server runs on `http://localhost:5173` by default and is configured with a proxy that forwards API requests to the backend service.
142+
The frontend development server runs on `http://localhost:5173` by default (each version may differ slightly, please check terminal output for details) and is configured with a proxy that forwards API requests to the backend service.
120143

121144
### Build Frontend Assets
122145

146+
Build the corresponding frontend assets as needed:
147+
148+
**New Frontend (default):**
149+
150+
```bash
151+
cd web/default
152+
bun run build # Build new frontend assets using bun
153+
```
154+
155+
**Classic Frontend (classic):**
156+
123157
```bash
124-
bun run build # Build frontend assets using bun
158+
cd web/classic
159+
bun run build # Build classic frontend assets using bun
125160
```
126161

127-
The built files will be generated into the `web/dist` directory, and the backend service will automatically load these static assets.
162+
The built files will be generated into their respective `dist` directories (e.g., `web/default/dist` or `web/classic/dist`), and the backend service will automatically load these static assets.
128163

129164
7. **Create a Pull Request**: Create a PR on GitHub, describing your changes.
130165

content/docs/ja/guide/feature-guide/admin/system-setting-advanced.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -602,8 +602,8 @@ Midjourneyなどの描画機能に関するパラメータを設定します。
602602
1. システム設定ページで「運営設定」タブをクリックします。
603603
2. 運営パラメータを設定します。
604604
- **新規ユーザー初期クォータ**:新規登録ユーザーの初期クォータ
605-
- **招待報酬クォータ**新規ユーザーを招待して登録した場合の報酬クォータ
606-
- **リベート率**招待されたユーザーの消費に対するリベート率(%)
605+
- **招待報酬クォータ**紹介されたユーザーが登録に成功した際に、紹介者が獲得する報酬クォータ
606+
- **リベート率**紹介されたユーザーがチャージした際に、紹介者が獲得するリベート率(%)
607607

608608
### チャージ設定
609609

content/docs/ja/guide/feature-guide/user/topup.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,13 @@ description: クォータはプラットフォーム内部の課金単位。複
3434

3535
## 紹介報酬
3636

37-
各アカウントには固有の紹介コードがあります。紹介した人が購入すると報酬クォータが得られます
37+
各アカウントには固有の紹介コードがあります。あなたの紹介コードを使って他のユーザーが登録を完了すると、紹介報酬を獲得できます
3838

39-
1. チャージページまたは個人設定ページで「紹介」エリアを見つけ、専用の紹介コードをコピーします
39+
### 紹介コードの取得
4040

41-
2. 紹介コードを他の人に共有します。相手は登録時にコードを入力します
42-
3. 紹介されたユーザーが購入すると、報酬クォータ残高が自動的に増加します
43-
4. 「残高に振り替え」ボタンをクリックして報酬クォータをメインアカウント残高に移すと使用できます
41+
チャージページまたは個人設定ページで「紹介」エリアを見つけ、専用の紹介コードをコピーします。
42+
43+
### 紹介報酬の仕組み
44+
45+
1. **登録時に即時付与**:招待されたユーザーが紹介コードを使って新規登録を完了すると、あなた(紹介者)はシステムで設定された「招待報酬クォータ」を即座に受け取ります(一回限りの付与)。
46+
2. **メイン残高への移行**:「残高に振り替え」ボタンをクリックすると、貯まった紹介報酬クォータをメインアカウントの残高に移行して利用できるようになります。

content/docs/ja/installation/config-maintenance/system-update.mdx

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,12 @@ git pull
9393
# 编译后端
9494
go build -o new-api
9595

96-
# 更新并编译前端
97-
cd web
96+
# フロントエンドの更新とビルド(必要に応じて新版または旧版を選択、ここでは新版を例とします)
97+
# 新版フロントエンド (default)
98+
cd web/default
9899
bun install
99100
bun run build
100-
cd
101+
cd ../..
101102
# 重启服务
102103
./new-api --port 3000
103104
```
@@ -160,11 +161,18 @@ git checkout v1.x.x
160161
# 重新编译
161162
go build -o new-api
162163

163-
# 更新并编译前端
164-
cd web
164+
# フロントエンドの更新とビルド(必要に応じて新版或者旧版を選択、ここでは新版を例とします)
165+
# 新版フロントエンド (default)
166+
cd web/default
165167
bun install
166168
bun run build
167-
cd ..
169+
cd ../..
170+
171+
# 旧版フロントエンド (classic)
172+
# cd web/classic
173+
# bun install
174+
# bun run build
175+
# cd ../..
168176

169177
# 重启服务
170178
./new-api --port 3000

content/docs/ja/installation/deployment-methods/local-development.mdx

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,26 +105,61 @@ brew install bun
105105

106106
### フロントエンド依存関係のインストール
107107

108+
開発またはビルドしたいフロントエンドのバージョンに応じて、対応するディレクトリに移動して依存関係のインストールと開発を行います:
109+
110+
#### 新版フロントエンド (default)
111+
108112
```bash
109-
cd web
110-
bun install # bun を使用してフロントエンド依存関係をインストール
113+
cd web/default
114+
bun install # bun を使用して新版フロントエンドの依存関係をインストール
115+
```
116+
117+
#### 旧版フロントエンド (classic)
118+
119+
```bash
120+
cd web/classic
121+
bun install # bun を使用して旧版フロントエンドの依存関係をインストール
111122
```
112123

113124
### 開発サーバーの実行
114125

126+
いずれかのフロントエンドバージョンを選択して実行します:
127+
128+
**新版フロントエンド (default):**
129+
130+
```bash
131+
cd web/default
132+
bun run dev # bun を使用して新版開発サーバーを実行
133+
```
134+
135+
**旧版フロントエンド (classic):**
136+
115137
```bash
116-
bun run dev # bun を使用して開発サーバーを実行
138+
cd web/classic
139+
bun run dev # bun を使用して旧版開発サーバーを実行
117140
```
118141

119-
フロントエンド開発サーバーはデフォルトで `http://localhost:5173` で実行され、API リクエストをバックエンドサービスに転送するようにプロキシが設定されています。
142+
フロントエンド開発サーバーはデフォルトで `http://localhost:5173` で実行され(各バージョンで若干異なる場合があります。詳細はターミナル出力を確認してください)、API リクエストをバックエンドサービスに転送するようにプロキシが設定されています。
120143

121144
### フロントエンドリソースのビルド
122145

146+
必要に応じて、対応するフロントエンドリソースをビルドします:
147+
148+
**新版フロントエンド (default):**
149+
150+
```bash
151+
cd web/default
152+
bun run build # bun を使用して新版フロントエンドリソースをビルド
153+
```
154+
155+
**旧版フロントエンド (classic):**
156+
123157
```bash
124-
bun run build # bun を使用してフロントエンドリソースをビルド
158+
cd web/classic
159+
bun run build # bun を使用して旧版フロントエンドリソースをビルド
125160
```
126161

127-
ビルドされたファイルは `web/dist` ディレクトリに生成され、バックエンドサービスがこれらの静的リソースを自動的にロードします。
162+
ビルドされたファイルはそれぞれの `dist` ディレクトリ(例:`web/default/dist` または `web/classic/dist`)に生成され、バックエンドサービスがこれらの静的リソースを自動的にロードします。
128163

129164
7. **プルリクエストの作成**: GitHub で PR を作成し、変更内容を記述します。
130165

content/docs/zh/guide/feature-guide/admin/system-setting-advanced.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -602,8 +602,8 @@ https://api.example.com/v1
602602
1. 在系统设置页点击「运营设置」标签页
603603
2. 配置运营参数:
604604
- **新用户初始配额**:新注册用户的初始配额
605-
- **邀请奖励配额**邀请新用户注册的奖励配额
606-
- **返利比例**被邀请用户消费的返利比例(%)
605+
- **邀请奖励配额**邀请新用户注册后,邀请人可获得的奖励配额
606+
- **返利比例**被邀请用户在充值时,邀请人可获得的返利配额比例(%)
607607

608608
### 充值配置
609609

content/docs/zh/guide/feature-guide/user/topup.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,15 @@ description: 配额是平台内部计费单位,支持多种方式充值
4949

5050
## 邀请返利
5151

52-
每个账号都有唯一的邀请码,邀请他人注册并消费后可获得返利配额
52+
每个账号都有唯一的邀请码,当其他人使用你的邀请码注册成功时,你即可获得邀请奖励
5353

5454
### 获取邀请码
5555

5656
在充值页或个人设置页找到「邀请」区域,复制你的专属邀请码
5757

5858
![邀请码与返利区域](/assets/guide/feature-guide/topup-invite.png)
5959

60-
### 使用返利配额
60+
### 邀请奖励机制
6161

62-
1. 将邀请码分享给他人,对方注册时填写邀请码
63-
2. 被邀请用户消费后,你的返利配额余额自动增加
64-
3. 点击「转入余额」按钮,将返利配额转入账户主余额后即可使用
62+
1. **注册即返利**:被邀请人使用你的邀请码注册成功后,你(邀请人)会立即获得系统配置的一笔「邀请奖励配额」(一次性到账)。
63+
2. **转入主余额**:点击「转入余额」按钮,即可将累计的返利配额转入你的账户主余额中进行使用。

0 commit comments

Comments
 (0)