From 2b3d064e6c9f5bfb35396195a5fd74617f37b86a Mon Sep 17 00:00:00 2001 From: CoderMageFox Date: Mon, 10 Nov 2025 14:03:17 +0800 Subject: [PATCH] docs: improve override_base_prompt explanation and update maintainer (#852) - Add visual diagrams to explain override_base_prompt behavior - Clarify the difference between "append" (false) and "replace" (true) modes - Add warning messages for advanced users about risks - Update maintainer to "Nofx Team CoderMageFox" - Improve both English and Chinese documentation This change addresses user confusion about the override_base_prompt setting by providing clear visual explanations and practical examples. Co-authored-by: tinkle-community --- docs/prompt-guide.md | 27 +++++++++++++++++++++++---- docs/prompt-guide.zh-CN.md | 27 +++++++++++++++++++++++---- 2 files changed, 46 insertions(+), 8 deletions(-) diff --git a/docs/prompt-guide.md b/docs/prompt-guide.md index c5832d4b..fb232070 100644 --- a/docs/prompt-guide.md +++ b/docs/prompt-guide.md @@ -45,12 +45,19 @@ A Prompt is the "work instruction" you give to the AI trader, determining how th **Suitable for**: Beginners who want to start quickly **Time required**: 2 minutes -#### Method 2: Add Custom Strategy on Top of Official Template +#### Method 2: Add Custom Strategy on Top of Official Template (Recommended) **Steps**: 1. Keep `prompts/default.txt` unchanged 2. Add your strategy in the web interface's "Custom Prompt" -3. Set `override_base_prompt = false` +3. **Turn OFF** "Override Base Prompt" switch (`override_base_prompt = false`) + +**Effect Explanation**: +``` +Final Prompt = Official Base Strategy (Risk Control + Format) + Your Custom Strategy + ↑ ↑ + System guarantees safety Your trading ideas +``` **Suitable for**: Intermediate users who want to keep risk controls but add their own ideas **Time required**: 10-30 minutes @@ -59,9 +66,21 @@ A Prompt is the "work instruction" you give to the AI trader, determining how th **Steps**: 1. Write a complete Prompt (including all risk control rules) -2. Set `override_base_prompt = true` +2. **Turn ON** "Override Base Prompt" switch (`override_base_prompt = true`) 3. ⚠️ You are responsible for all risk controls and output formats +**Effect Explanation**: +``` +Final Prompt = Your Custom Strategy (Complete Replacement) + ↑ + You need to ensure safety and correct format yourself +``` + +**Important Warnings**: +- ❌ When enabled, the system will NOT automatically add risk control rules +- ❌ Incorrect output format will cause trading failures +- ⚠️ Only suitable for advanced users who fully understand the system mechanism + **Suitable for**: Advanced users who fully understand the system mechanism **Time required**: 1-2 hours @@ -1507,4 +1526,4 @@ Actual Behavior: [What actually happened] **Document Version**: v1.0 **Last Updated**: 2025-01-09 -**Maintainer**: NoFx Team +**Maintainer**: Nofx Team CoderMageFox diff --git a/docs/prompt-guide.zh-CN.md b/docs/prompt-guide.zh-CN.md index 656c9530..a853a92f 100644 --- a/docs/prompt-guide.zh-CN.md +++ b/docs/prompt-guide.zh-CN.md @@ -45,12 +45,19 @@ Prompt 是你给 AI 交易员的"工作指令"，决定了 AI 如何分析市场 **适合**: 新手用户，想快速开始 **耗时**: 2分钟 -#### 方式2：在官方模板基础上添加个性化策略 +#### 方式2：在官方模板基础上添加个性化策略（推荐） **步骤**: 1. 保持 `prompts/default.txt` 不变 2. 在 Web 界面的"自定义 Prompt"中添加你的策略 -3. 设置 `override_base_prompt = false` +3. **关闭** "覆盖默认提示词" 开关（`override_base_prompt = false`） + +**效果说明**: +``` +最终提示词 = 官方基础策略（风控+格式） + 你的自定义策略 + ↑ ↑ + 系统保证安全 你的交易想法 +``` **适合**: 进阶用户，想保留风控但加入自己的想法 **耗时**: 10-30分钟 @@ -59,9 +66,21 @@ Prompt 是你给 AI 交易员的"工作指令"，决定了 AI 如何分析市场 **步骤**: 1. 编写完整的 Prompt（包含所有风控规则） -2. 设置 `override_base_prompt = true` +2. **开启** "覆盖默认提示词" 开关（`override_base_prompt = true`） 3. ⚠️ 需要自行负责所有风控和输出格式 +**效果说明**: +``` +最终提示词 = 你的自定义策略（完全替换） + ↑ + 你需要自己保证安全和格式正确 +``` + +**重要警告**: +- ❌ 开启后，系统不会自动添加风控规则 +- ❌ 输出格式错误会导致交易失败 +- ⚠️ 仅适合完全理解系统机制的高级用户 + **适合**: 高级用户，完全理解系统机制 **耗时**: 1-2小时 @@ -1508,4 +1527,4 @@ Prompt 内容： **文档版本**: v1.0 **最后更新**: 2025-01-09 -**维护者**: NoFx Team +**维护者**: Nofx Team CoderMageFox