Commit Graph

2 Commits

Author SHA1 Message Date
CoderMageFox 2b3d064e6c 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 <tinklefund@gmail.com>
2025-11-10 14:03:17 +08:00
CoderMageFox f7498ef346 docs(prompt): add comprehensive prompt writing guide (#837)
* docs: 添加 Prompt 编写指南并更新 README 导航
为 NoFx 系统创建完整的 Prompt 编写指南文档,帮助用户编写高质量的自定义 AI 交易策略提示词。
主要内容:
- 📚 快速开始指南(5分钟上手)
- 💡 核心概念和工作原理
- 📋 完整的可用字段参考(系统状态、账户信息、持仓信息等)
- ⚖️ 系统约束和规则说明
- 📦 三种官方策略模板(保守型/平衡型/激进型)
-  质量检查清单(20+ 检查项)
-  10个常见错误案例和最佳实践
- 🎓 高级话题(完全自定义、调试指南)
文档特点:
- 基于实际代码(decision/engine.go)确保字段准确性
- 三层用户分级(新手/进阶/高级)
- 完整的策略模板即拿即用
-  对比示例避免常见错误
- 20,000+ 字完整覆盖所有关键知识点
同时更新 README.md 添加文档导航链接,方便用户快速访问。
Fixes #654
Co-Authored-By: tinkle-community <tinklefund@gmail.com>
* docs(prompt): add i18n support with complete English translation
完善 Prompt 编写指南的国际化支持,添加完整的英文翻译版本。
主要更改:
- 📝 新增英文版本:docs/prompt-guide.md
- 🇨🇳 中文版本重命名:docs/prompt-guide.zh-CN.md
- 🔗 更新 README.md 文档链接,标注语言选项
文档特点:
- 完整翻译所有章节(20,000+ 字)
- 保持中英文结构完全一致
- 遵循项目 i18n 惯例(参考 docs/guides/)
- 便于不同语言用户使用
Related to #654
Co-Authored-By: tinkle-community <tinklefund@gmail.com>
---------
Co-authored-by: tinkle-community <tinklefund@gmail.com>
2025-11-10 11:44:17 +08:00