update docs

This commit is contained in:
tinkle-community
2025-12-21 01:36:16 +08:00
parent 27196a379e
commit 16ff57778d
37 changed files with 86 additions and 86 deletions
+2 -2
View File
@@ -143,7 +143,7 @@ Files GitHub needs to see:
```
**GitHub URLs automatically redirect!**
- Old: `github.com/tinkle-community/nofx/blob/main/DOCKER_DEPLOY.en.md`
- Old: `github.com/NoFxAiOS/nofx/blob/main/DOCKER_DEPLOY.en.md`
- Will redirect to: `github.com/.../docs/getting-started/docker-deploy.en.md`
## 🛠️ For Contributors
@@ -224,7 +224,7 @@ Closes #XXX
3. Ask in [Telegram](https://t.me/nofx_dev_community)
**Link broken?**
- Report in [GitHub Issues](https://github.com/tinkle-community/nofx/issues)
- Report in [GitHub Issues](https://github.com/NoFxAiOS/nofx/issues)
- We'll fix it ASAP!
**Want to contribute docs?**
+5 -5
View File
@@ -58,7 +58,7 @@ Welcome to the NOFX documentation! This page helps you find the right documentat
**Get Involved:**
- 💬 [Telegram Community](https://t.me/nofx_dev_community)
- 🐦 [Twitter @nofx_official](https://x.com/nofx_official)
- 🐛 [Report Issues](https://github.com/tinkle-community/nofx/issues)
- 🐛 [Report Issues](https://github.com/NoFxAiOS/nofx/issues)
---
@@ -122,8 +122,8 @@ Welcome to the NOFX documentation! This page helps you find the right documentat
### I want to...
- 🚀 **Get started quickly** → [Getting Started](getting-started/README.md) / [快速开始](getting-started/README.zh-CN.md)
- 🐛 **Report a bug** → [GitHub Issues](https://github.com/tinkle-community/nofx/issues/new)
- 💡 **Suggest a feature** → [Feature Request](https://github.com/tinkle-community/nofx/issues/new?template=feature_request.md)
- 🐛 **Report a bug** → [GitHub Issues](https://github.com/NoFxAiOS/nofx/issues/new)
- 💡 **Suggest a feature** → [Feature Request](https://github.com/NoFxAiOS/nofx/issues/new?template=feature_request.md)
- 🔒 **Report security issue** → [Security Policy](../SECURITY.md)
- 💰 **Claim a bounty** → [Bounty Guide](community/bounty-guide.md)
- 🤝 **Contribute code** → [Contributing Guide](../CONTRIBUTING.md)
@@ -165,7 +165,7 @@ Welcome to the NOFX documentation! This page helps you find the right documentat
1. **Search GitHub Issues** - Someone might have asked already
2. **Join Telegram** - [NOFX Developer Community](https://t.me/nofx_dev_community)
3. **Ask on Twitter** - Mention [@nofx_official](https://x.com/nofx_official)
4. **Create an Issue** - [New Issue](https://github.com/tinkle-community/nofx/issues/new)
4. **Create an Issue** - [New Issue](https://github.com/NoFxAiOS/nofx/issues/new)
---
@@ -186,4 +186,4 @@ Found an error or want to improve the docs?
---
**Last Updated:** 2025-11-01
**Maintained by:** [Tinkle Community](https://github.com/tinkle-community)
**Maintained by:** [NOFX Community](https://github.com/NoFxAiOS)
+2 -2
View File
@@ -83,7 +83,7 @@ If you prefer to do it manually:
```bash
# Add upstream if not already added
git remote add upstream https://github.com/tinkle-community/nofx.git
git remote add upstream https://github.com/NoFxAiOS/nofx.git
# Fetch latest changes
git fetch upstream
@@ -255,7 +255,7 @@ If the migration script doesn't work:
**Stuck on migration?**
- Comment on your PR
- Ask in [Telegram](https://t.me/nofx_dev_community)
- Open a [Discussion](https://github.com/tinkle-community/nofx/discussions)
- Open a [Discussion](https://github.com/NoFxAiOS/nofx/discussions)
**We're here to help you succeed!** 🚀
@@ -83,7 +83,7 @@ git push -f origin <your-pr-branch>
```bash
# 如果还没添加 upstream,添加它
git remote add upstream https://github.com/tinkle-community/nofx.git
git remote add upstream https://github.com/NoFxAiOS/nofx.git
# 获取最新更改
git fetch upstream
@@ -255,7 +255,7 @@ git push -f origin <your-pr-branch>
**迁移遇到困难?**
- 在你的 PR 中评论
- 在 [Telegram](https://t.me/nofx_dev_community) 提问
- 开启 [Discussion](https://github.com/tinkle-community/nofx/discussions)
- 开启 [Discussion](https://github.com/NoFxAiOS/nofx/discussions)
**我们在这里帮助你成功!** 🚀
+4 -4
View File
@@ -246,7 +246,7 @@ Don't panic! We're here to help.
- Merge conflicts → Rebase on latest `dev`
**Need help?** Just ask! Comment in your PR or reach out:
- [GitHub Discussions](https://github.com/tinkle-community/nofx/discussions)
- [GitHub Discussions](https://github.com/NoFxAiOS/nofx/discussions)
- [Telegram Community](https://t.me/nofx_dev_community)
---
@@ -323,11 +323,11 @@ This new system helps YOU by:
### Helpful Links
- [Conventional Commits](https://www.conventionalcommits.org/) - Commit format
- [Good First Issues](https://github.com/tinkle-community/nofx/labels/good%20first%20issue) - Beginner-friendly tasks
- [Good First Issues](https://github.com/NoFxAiOS/nofx/labels/good%20first%20issue) - Beginner-friendly tasks
- [Bounty Program](../bounty-guide.md) - Get paid to contribute
### Get Help
- [GitHub Discussions](https://github.com/tinkle-community/nofx/discussions) - Ask questions
- [GitHub Discussions](https://github.com/NoFxAiOS/nofx/discussions) - Ask questions
- [Telegram](https://t.me/nofx_dev_community) - Community chat
- [Twitter](https://x.com/nofx_official) - Updates and announcements
@@ -341,7 +341,7 @@ This is a new system and we want YOUR input:
- 🤔 What concerns do you have?
- 💡 How can we improve?
Share in the [Migration Feedback Discussion](https://github.com/tinkle-community/nofx/discussions) (link TBD)
Share in the [Migration Feedback Discussion](https://github.com/NoFxAiOS/nofx/discussions) (link TBD)
---
@@ -246,7 +246,7 @@ perf(ai): optimize prompt generation
- 合并冲突 → 基于最新 `dev` rebase
**需要帮助?** 只管问!在你的 PR 中评论或联系:
- [GitHub Discussions](https://github.com/tinkle-community/nofx/discussions)
- [GitHub Discussions](https://github.com/NoFxAiOS/nofx/discussions)
- [Telegram 社区](https://t.me/nofx_dev_community)
---
@@ -323,11 +323,11 @@ perf(ai): optimize prompt generation
### 有用链接
- [Conventional Commits](https://www.conventionalcommits.org/) - Commit 格式
- [Good First Issues](https://github.com/tinkle-community/nofx/labels/good%20first%20issue) - 适合初学者的任务
- [Good First Issues](https://github.com/NoFxAiOS/nofx/labels/good%20first%20issue) - 适合初学者的任务
- [悬赏计划](../bounty-guide.md) - 获得报酬来贡献
### 获取帮助
- [GitHub Discussions](https://github.com/tinkle-community/nofx/discussions) - 提问
- [GitHub Discussions](https://github.com/NoFxAiOS/nofx/discussions) - 提问
- [Telegram](https://t.me/nofx_dev_community) - 社区聊天
- [Twitter](https://x.com/nofx_official) - 更新和公告
@@ -341,7 +341,7 @@ perf(ai): optimize prompt generation
- 🤔 你有什么顾虑?
- 💡 我们如何改进?
在[迁移反馈讨论](https://github.com/tinkle-community/nofx/discussions)中分享(链接待定)
在[迁移反馈讨论](https://github.com/NoFxAiOS/nofx/discussions)中分享(链接待定)
---
+6 -6
View File
@@ -49,8 +49,8 @@ git push origin <your-branch-name>
### 📖 Learn More
- [Migration Announcement](https://github.com/tinkle-community/nofx/blob/dev/docs/community/MIGRATION_ANNOUNCEMENT.md)
- [Contributing Guidelines](https://github.com/tinkle-community/nofx/blob/dev/CONTRIBUTING.md)
- [Migration Announcement](https://github.com/NoFxAiOS/nofx/blob/dev/docs/community/MIGRATION_ANNOUNCEMENT.md)
- [Contributing Guidelines](https://github.com/NoFxAiOS/nofx/blob/dev/CONTRIBUTING.md)
### ❓ Questions?
@@ -108,8 +108,8 @@ git push origin <your-branch-name>
### 📖 了解更多
- [迁移公告](https://github.com/tinkle-community/nofx/blob/dev/docs/community/MIGRATION_ANNOUNCEMENT.zh-CN.md)
- [贡献指南](https://github.com/tinkle-community/nofx/blob/dev/docs/i18n/zh-CN/CONTRIBUTING.md)
- [迁移公告](https://github.com/NoFxAiOS/nofx/blob/dev/docs/community/MIGRATION_ANNOUNCEMENT.zh-CN.md)
- [贡献指南](https://github.com/NoFxAiOS/nofx/blob/dev/docs/i18n/zh-CN/CONTRIBUTING.md)
### ❓ 问题?
@@ -136,7 +136,7 @@ We're introducing a new PR system. Your PR won't be blocked - we'll review it no
./scripts/pr-check.sh
```
[Learn more](https://github.com/tinkle-community/nofx/blob/dev/docs/community/MIGRATION_ANNOUNCEMENT.md) | This is optional!
[Learn more](https://github.com/NoFxAiOS/nofx/blob/dev/docs/community/MIGRATION_ANNOUNCEMENT.md) | This is optional!
```
---
@@ -159,7 +159,7 @@ We're introducing a new PR system. Your PR won't be blocked - we'll review it no
./scripts/pr-check.sh
\`\`\`
[Learn more](https://github.com/tinkle-community/nofx/blob/dev/docs/community/MIGRATION_ANNOUNCEMENT.md) | This is optional!"
[Learn more](https://github.com/NoFxAiOS/nofx/blob/dev/docs/community/MIGRATION_ANNOUNCEMENT.md) | This is optional!"
echo "✅ Commented on PR #$pr_number"
sleep 2 # Be nice to GitHub API
+6 -6
View File
@@ -28,14 +28,14 @@ We're introducing a new PR management system to improve code quality and make co
- [Security Policy](../../SECURITY.md) - Report vulnerabilities
2. **Find Something to Work On**
- Browse [GitHub Issues](https://github.com/tinkle-community/nofx/issues)
- Browse [GitHub Issues](https://github.com/NoFxAiOS/nofx/issues)
- Look for `good first issue` label
- Check out [bounty tasks](#-bounty-program)
3. **Join the Community**
- 💬 [Telegram Developer Community](https://t.me/nofx_dev_community)
- 🐦 [Twitter @nofx_official](https://x.com/nofx_official)
- 🐙 [GitHub Discussions](https://github.com/tinkle-community/nofx/discussions)
- 🐙 [GitHub Discussions](https://github.com/NoFxAiOS/nofx/discussions)
---
@@ -139,7 +139,7 @@ NOFX offers bounties for valuable contributions:
| Platform | Purpose | Link |
|----------|---------|------|
| 💬 Telegram | Real-time chat, questions | [Join](https://t.me/nofx_dev_community) |
| 🐙 GitHub | Issues, PRs, discussions | [Visit](https://github.com/tinkle-community/nofx) |
| 🐙 GitHub | Issues, PRs, discussions | [Visit](https://github.com/NoFxAiOS/nofx) |
| 🐦 Twitter | Announcements, updates | [@nofx_official](https://x.com/nofx_official) |
### Core Team
@@ -228,10 +228,10 @@ NOFX offers bounties for valuable contributions:
| Metric | Count |
|--------|-------|
| GitHub Stars | Check [repo](https://github.com/tinkle-community/nofx) |
| GitHub Stars | Check [repo](https://github.com/NoFxAiOS/nofx) |
| Contributors | 21+ |
| Open Issues | Check [issues](https://github.com/tinkle-community/nofx/issues) |
| Merged PRs | Check [pulls](https://github.com/tinkle-community/nofx/pulls?q=is%3Apr+is%3Amerged) |
| Open Issues | Check [issues](https://github.com/NoFxAiOS/nofx/issues) |
| Merged PRs | Check [pulls](https://github.com/NoFxAiOS/nofx/pulls?q=is%3Apr+is%3Amerged) |
---
+2 -2
View File
@@ -6,7 +6,7 @@
1. **访问项目 Issues 页面**
```
https://github.com/tinkle-community/nofx/issues
https://github.com/NoFxAiOS/nofx/issues
```
2. **点击 "New Issue" 按钮**
@@ -215,7 +215,7 @@ Details: [详情链接]
## 📞 需要帮助?
- **GitHub Issues**: https://github.com/tinkle-community/nofx/issues
- **GitHub Issues**: https://github.com/NoFxAiOS/nofx/issues
- **Telegram**: https://t.me/nofx_dev_community
- **Twitter/X**: [@Web3Tinkle](https://x.com/Web3Tinkle)
+1 -1
View File
@@ -115,7 +115,7 @@ For single-tenant/self-hosted usage, you can enable strict admin-only access:
**Need more help?**
- 📖 [FAQ](../guides/faq.zh-CN.md)
- 💬 [Telegram Community](https://t.me/nofx_dev_community)
- 🐛 [GitHub Issues](https://github.com/tinkle-community/nofx/issues)
- 🐛 [GitHub Issues](https://github.com/NoFxAiOS/nofx/issues)
---
+1 -1
View File
@@ -96,7 +96,7 @@ cp config.json.example config.json
**需要更多帮助?**
- 📖 [常见问题](../guides/faq.zh-CN.md)
- 💬 [Telegram 社区](https://t.me/nofx_dev_community)
- 🐛 [GitHub Issues](https://github.com/tinkle-community/nofx/issues)
- 🐛 [GitHub Issues](https://github.com/NoFxAiOS/nofx/issues)
---
+1 -1
View File
@@ -130,7 +130,7 @@ Run multiple AI models simultaneously:
**Can't find what you need?**
- 💬 [Telegram Community](https://t.me/nofx_dev_community)
- 🐛 [GitHub Issues](https://github.com/tinkle-community/nofx/issues)
- 🐛 [GitHub Issues](https://github.com/NoFxAiOS/nofx/issues)
- 🐦 [Twitter @nofx_official](https://x.com/nofx_official)
---
+1 -1
View File
@@ -129,7 +129,7 @@ sudo apt-get install libta-lib0-dev
**找不到您需要的内容?**
- 💬 [Telegram 社区](https://t.me/nofx_dev_community)
- 🐛 [GitHub Issues](https://github.com/tinkle-community/nofx/issues)
- 🐛 [GitHub Issues](https://github.com/NoFxAiOS/nofx/issues)
- 🐦 [Twitter @nofx_official](https://x.com/nofx_official)
---
+3 -3
View File
@@ -226,7 +226,7 @@ docker info | grep -A 10 "Registry Mirrors"
# Should show your configured mirrors
```
**Related Issue:** [#168](https://github.com/tinkle-community/nofx/issues/168)
**Related Issue:** [#168](https://github.com/NoFxAiOS/nofx/issues/168)
---
@@ -340,7 +340,7 @@ Binance has strict API rate limits:
- Reduce number of traders
- Increase decision interval (e.g., from 1min to 3-5min)
**Related Issue:** [#60](https://github.com/tinkle-community/nofx/issues/60)
**Related Issue:** [#60](https://github.com/NoFxAiOS/nofx/issues/60)
---
@@ -559,7 +559,7 @@ If you've tried all the above and still have problems:
3. **Join Community:**
- [Telegram Developer Community](https://t.me/nofx_dev_community)
- [GitHub Discussions](https://github.com/tinkle-community/nofx/discussions)
- [GitHub Discussions](https://github.com/NoFxAiOS/nofx/discussions)
---
+3 -3
View File
@@ -226,7 +226,7 @@ docker info | grep -A 10 "Registry Mirrors"
# 应该显示你配置的镜像源
```
**相关 Issue:** [#168](https://github.com/tinkle-community/nofx/issues/168)
**相关 Issue:** [#168](https://github.com/NoFxAiOS/nofx/issues/168)
---
@@ -340,7 +340,7 @@ environment:
- 减少交易员数量
- 增加决策间隔时间(例如从 1 分钟改为 3-5 分钟)
**相关 Issue:** [#60](https://github.com/tinkle-community/nofx/issues/60)
**相关 Issue:** [#60](https://github.com/NoFxAiOS/nofx/issues/60)
---
@@ -559,7 +559,7 @@ docker compose exec postgres \
3. **加入社区:**
- [Telegram 开发者社区](https://t.me/nofx_dev_community)
- [GitHub Discussions](https://github.com/tinkle-community/nofx/discussions)
- [GitHub Discussions](https://github.com/NoFxAiOS/nofx/discussions)
---
+5 -5
View File
@@ -80,7 +80,7 @@ Default: **3 positions**. This is a soft limit defined in the AI prompt, not har
**Why**: NOFX uses `PositionSide(LONG/SHORT)` which requires Hedge Mode.
See [Issue #202](https://github.com/tinkle-community/nofx/issues/202) and [Troubleshooting Guide](TROUBLESHOOTING.md#-only-opening-short-positions-issue-202).
See [Issue #202](https://github.com/NoFxAiOS/nofx/issues/202) and [Troubleshooting Guide](TROUBLESHOOTING.md#-only-opening-short-positions-issue-202).
---
@@ -178,13 +178,13 @@ See the comprehensive [Troubleshooting Guide](TROUBLESHOOTING.md) for:
### How do I report a bug?
1. Check [Troubleshooting Guide](TROUBLESHOOTING.md) first
2. Search [existing issues](https://github.com/tinkle-community/nofx/issues)
2. Search [existing issues](https://github.com/NoFxAiOS/nofx/issues)
3. If not found, use our [Bug Report Template](../../.github/ISSUE_TEMPLATE/bug_report.md)
### Where can I get help?
- [GitHub Discussions](https://github.com/tinkle-community/nofx/discussions)
- [GitHub Discussions](https://github.com/NoFxAiOS/nofx/discussions)
- [Telegram Community](https://t.me/nofx_dev_community)
- [GitHub Issues](https://github.com/tinkle-community/nofx/issues)
- [GitHub Issues](https://github.com/NoFxAiOS/nofx/issues)
---
@@ -198,7 +198,7 @@ Yes! We welcome contributions:
- See [Contributing Guide](../CONTRIBUTING.md)
### How do I suggest new features?
Open a [Feature Request](https://github.com/tinkle-community/nofx/issues/new/choose) with your idea!
Open a [Feature Request](https://github.com/NoFxAiOS/nofx/issues/new/choose) with your idea!
---
+5 -5
View File
@@ -80,7 +80,7 @@ AI 交易是**实验性**的,**不保证盈利**。请始终用小额资金测
**原因**NOFX 使用 `PositionSide(LONG/SHORT)`,需要双向持仓模式。
参见 [Issue #202](https://github.com/tinkle-community/nofx/issues/202) 和[故障排查指南](TROUBLESHOOTING.zh-CN.md#-只开空单-issue-202)。
参见 [Issue #202](https://github.com/NoFxAiOS/nofx/issues/202) 和[故障排查指南](TROUBLESHOOTING.zh-CN.md#-只开空单-issue-202)。
---
@@ -178,13 +178,13 @@ docker compose exec postgres \
### 如何报告 Bug
1. 先查看[故障排查指南](TROUBLESHOOTING.zh-CN.md)
2. 搜索[现有 Issues](https://github.com/tinkle-community/nofx/issues)
2. 搜索[现有 Issues](https://github.com/NoFxAiOS/nofx/issues)
3. 如果没找到,使用我们的 [Bug 报告模板](../../.github/ISSUE_TEMPLATE/bug_report.md)
### 在哪里可以获得帮助?
- [GitHub Discussions](https://github.com/tinkle-community/nofx/discussions)
- [GitHub Discussions](https://github.com/NoFxAiOS/nofx/discussions)
- [Telegram 社区](https://t.me/nofx_dev_community)
- [GitHub Issues](https://github.com/tinkle-community/nofx/issues)
- [GitHub Issues](https://github.com/NoFxAiOS/nofx/issues)
---
@@ -198,7 +198,7 @@ docker compose exec postgres \
- 查看[贡献指南](../CONTRIBUTING.md)
### 如何建议新功能?
提交 [Feature Request](https://github.com/tinkle-community/nofx/issues/new/choose) 说明您的想法!
提交 [Feature Request](https://github.com/NoFxAiOS/nofx/issues/new/choose) 说明您的想法!
---
+1 -1
View File
@@ -219,7 +219,7 @@ faq.zh-CN.md → Chinese FAQ
**Questions? / 有问题?**
- 💬 Ask in [Telegram Community](https://t.me/nofx_dev_community)
- 🐙 Open a [GitHub Issue](https://github.com/tinkle-community/nofx/issues)
- 🐙 Open a [GitHub Issue](https://github.com/NoFxAiOS/nofx/issues)
- 📧 Contact maintainers
**Resources / 资源:**
+3 -3
View File
@@ -87,7 +87,7 @@ git clone https://github.com/YOUR_USERNAME/nofx.git
cd nofx
# 添加 upstream remote
git remote add upstream https://github.com/tinkle-community/nofx.git
git remote add upstream https://github.com/NoFxAiOS/nofx.git
```
### 2. 创建功能分支
@@ -442,7 +442,7 @@ docs: update Docker deployment guide
### 工作方式
1. 查看[悬赏 issue](https://github.com/tinkle-community/nofx/labels/bounty)
1. 查看[悬赏 issue](https://github.com/NoFxAiOS/nofx/labels/bounty)
2. 评论认领(先到先得)
3. 在截止日期前完成工作
4. 提交 PR 并填写悬赏认领部分
@@ -461,7 +461,7 @@ docs: update Docker deployment guide
## ❓ 问题?
- **一般问题:** 加入我们的 [Telegram 社区](https://t.me/nofx_dev_community)
- **技术问题:** 开启[讨论](https://github.com/tinkle-community/nofx/discussions)
- **技术问题:** 开启[讨论](https://github.com/NoFxAiOS/nofx/discussions)
- **安全问题:** 查看[安全政策](../../../SECURITY.md)
- **Bug 报告:** 使用 [Bug 报告模板](../../../.github/ISSUE_TEMPLATE/bug_report.md)
+1 -1
View File
@@ -42,7 +42,7 @@ Everything here is transparent and designed to help you contribute successfully!
## 📞 Questions?
- **Public questions:** Use [GitHub Discussions](https://github.com/tinkle-community/nofx/discussions)
- **Public questions:** Use [GitHub Discussions](https://github.com/NoFxAiOS/nofx/discussions)
- **Maintainer questions:** Use the maintainer channel
- **Migration questions:** See [Migration Announcement](../community/MIGRATION_ANNOUNCEMENT.md)
+1 -1
View File
@@ -42,7 +42,7 @@
## 📞 问题?
- **公开问题:** 使用 [GitHub Discussions](https://github.com/tinkle-community/nofx/discussions)
- **公开问题:** 使用 [GitHub Discussions](https://github.com/NoFxAiOS/nofx/discussions)
- **维护者问题:** 使用维护者频道
- **迁移问题:** 查看[迁移公告](../community/MIGRATION_ANNOUNCEMENT.zh-CN.md)