mirror of
https://github.com/NoFxAiOS/nofx.git
synced 2026-06-06 05:51:19 +08:00
f7498ef346
* 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>
📚 NOFX Documentation Center / 文档中心
Welcome to the NOFX documentation! This page helps you find the right documentation quickly.
欢迎来到 NOFX 文档中心！本页面帮助您快速找到所需文档。
🚀 Getting Started / 快速开始
New to NOFX? Start here!
| Document | Description | 描述 |
|---|---|---|
| Main README | Project overview, features, quick start | 项目概述、功能、快速入门 |
| Getting Started Index (EN) | All deployment options | 所有部署选项 |
| Getting Started Index (中文) | 所有部署选项 | All deployment options |
| Docker Deployment (EN) | Deploy with Docker (recommended) | Docker 部署（推荐） |
| Docker Deployment (中文) | Docker 部署指南（中文） | Docker deployment guide |
| PM2 Deployment (EN) | Deploy with PM2 process manager | PM2 进程管理器部署 |
| PM2 Deployment (中文) | PM2 部署指南（中文） | PM2 deployment guide |
| Custom API (EN) | Connect custom AI API providers | 连接自定义 AI API |
| Custom API (中文) | 连接自定义 AI API 提供商 | Custom AI provider guide |
Quick Links:
- 📖 See all options → Getting Started / 快速开始
- 🐳 Want easiest setup? → Docker (EN) / Docker (中文)
- 🔧 Advanced user? → PM2 (EN) / PM2 (中文)
- 🤖 Custom AI model? → Custom API (EN) / 自定义 API
📘 User Guides / 使用指南
Learn how to use NOFX effectively
| Document | Description | 描述 |
|---|---|---|
| User Guides Index (EN) | All usage guides and tips | 所有使用指南和技巧 |
| User Guides Index (中文) | 所有使用指南和技巧 | All usage guides and tips |
| FAQ (English) | Frequently asked questions | 常见问题解答 |
| FAQ (中文) | 常见问题解答 | Frequently asked questions |
| Troubleshooting (coming soon) | Common issues and solutions | 故障排查 |
| Configuration Guide (coming soon) | Advanced configuration options | 高级配置选项 |
| Trading Strategies (coming soon) | AI trading strategy examples | AI 交易策略示例 |
👥 Community & Contributing / 社区与贡献
Join the community and contribute!
| Document | Description | 描述 |
|---|---|---|
| Code of Conduct | Community guidelines | 社区行为准则 |
| Security Policy | Report security vulnerabilities | 报告安全漏洞 |
| Bounty Guide | How to post bounty tasks | 如何发布悬赏任务 |
| Hyperliquid Bounty | Hyperliquid integration bounty | Hyperliquid 集成悬赏 |
| Aster Bounty | Aster DEX integration bounty | Aster DEX 集成悬赏 |
Get Involved:
🌍 International / 国际化文档
Documentation in other languages
| Language | Main README | Status |
|---|---|---|
| 🇨🇳 Chinese (中文) | README.md | ✅ Complete |
| 🇷🇺 Russian (Русский) | README.md | ✅ Complete |
| 🇺🇦 Ukrainian (Українська) | README.md | ✅ Complete |
| 🇬🇧 English | README.md | ✅ Complete |
🏗️ Architecture & Development / 架构与开发
For developers who want to understand the internals
| Document | Description | 描述 |
|---|---|---|
| Architecture Overview (EN) | System architecture, modules, and design | 系统架构、模块和设计 |
| Architecture Overview (中文) | 系统架构、模块和设计 | System architecture overview |
| API Reference (coming soon) | HTTP API documentation | HTTP API 文档 |
| Database Schema (coming soon) | SQLite database structure | SQLite 数据库结构 |
| Testing Guide (coming soon) | How to write tests | 如何编写测试 |
🗺️ Roadmap / 路线图
NOFX's strategic development plan and market expansion
| Document | Description | 描述 |
|---|---|---|
| Roadmap (EN) | Short-term and long-term roadmap, feature timeline | 短期和长期路线图、功能时间表 |
| Roadmap (中文) | 短期和长期路线图、功能时间表 | Strategic development plan |
Roadmap Highlights:
- 📈 Short-term (Q2-Q3 2025): Advanced risk management, multi-AI ensemble, new exchange integrations
- 🚀 Long-term (2026): Universal market expansion (stocks, futures, options, forex), reinforcement learning, enterprise features
📄 Legal & Policies / 法律与政策
| Document | Description | 描述 |
|---|---|---|
| License (MIT) | Open source license | 开源许可证 |
| Changelog (EN) | Version history and updates | 版本历史和更新 |
| Changelog (中文) | 版本历史和更新 | Version history and updates |
| Security Policy | Vulnerability disclosure | 漏洞披露政策 |
| Code of Conduct | Community standards | 社区标准 |
🔍 Quick Navigation / 快速导航
Find what you need fast:
I want to...
- 🚀 Get started quickly → Getting Started / 快速开始
- 🐛 Report a bug → GitHub Issues
- 💡 Suggest a feature → Feature Request
- 🔒 Report security issue → Security Policy
- 💰 Claim a bounty → Bounty Guide
- 🤝 Contribute code → Contributing Guide
- 💬 Ask questions → Telegram Community
I'm looking for...
- 🏗️ System architecture → Architecture (EN) / 架构文档
- 🗺️ Product roadmap → Roadmap (EN) / 路线图
- 📊 API documentation → Coming soon
- 🧪 Testing guide → Coming soon
- 🔧 Configuration examples → Custom API (EN) / 自定义 API
- 🌐 Multi-language docs → International section
📚 Documentation Status
| Category | Status | Last Updated |
|---|---|---|
| Getting Started | ✅ Complete | 2025-11-01 |
| User Guides | ✅ Complete | 2025-11-01 |
| Community | ✅ Complete | 2025-11-01 |
| Architecture | ✅ Complete | 2025-11-01 |
| Roadmap | ✅ Complete | 2025-11-01 |
| API Reference | 📋 Planned | - |
Legend:
- ✅ Complete - Documentation is ready
- 🚧 In Progress - Being written
- 📋 Planned - On the roadmap
- ⚠️ Outdated - Needs update
🆘 Need Help?
Can't find what you're looking for?
- Search GitHub Issues - Someone might have asked already
- Join Telegram - NOFX Developer Community
- Ask on Twitter - Mention @nofx_ai
- Create an Issue - New Issue
🤝 Contributing to Documentation
Found an error or want to improve the docs?
- Small fixes - Click "Edit" on GitHub and submit PR
- New documentation - Create an issue first to discuss
- Translations - See Contributing Guide
Documentation Contributors:
- All documentation follows Markdown Guide
- Use clear, concise language
- Include code examples where helpful
- Add screenshots for UI-related docs
Last Updated: 2025-11-01 Maintained by: Tinkle Community