docs/README.md
Welcome to the NOFX documentation! This page helps you find the right documentation quickly.
欢è¿æ¥å° NOFX ææ¡£äžå¿ïŒæ¬é¡µé¢åž®å©æšå¿«éæŸå°æéææ¡£ã
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 |
| Custom API (EN) | Connect custom AI API providers | è¿æ¥èªå®ä¹ AI API |
| Custom API (äžæ) | è¿æ¥èªå®ä¹ AI API æäŸå | Custom AI provider guide |
Quick Links:
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 亀æçç¥ç€ºäŸ |
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:
Documentation in other languages
| Language | Main README | Status |
|---|---|---|
| ðšð³ Chinese (äžæ) | README.md | â Complete |
| ð·ðº Russian (Ð ÑÑÑкОй) | README.md | â Complete |
| ðºðŠ Ukrainian (УкÑаÑÐœÑÑка) | README.md | â Complete |
| ð¬ð§ English | README.md | â Complete |
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 | åŠäœçŒåæµè¯ |
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:
| 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 | 瀟åºæ å |
Find what you need fast:
| 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:
Can't find what you're looking for?
Found an error or want to improve the docs?
Documentation Contributors:
Last Updated: 2025-11-01 Maintained by: NOFX Community