AI Agent金融科技后端前端【免费下载链接】nofxYour AI trading terminal assistant for US stocks, commodities, forex, and crypto.项目地址https://gitcode.com/gh_mirrors/nof/nofx点击查看免费下载本指南完整梳理 NOFX 开源仓库文档结构的重组方案从根目录堆叠 15 个 Markdown 文件的旧布局迁移为以docs/为枢纽的多级分类结构。读者将掌握文件新旧位置对照、相对链接重写方法、目录级检索命令以及新增文档时应当遵循的提交规范可直接用于参与 NOFX 文档维护或复用同类仓库的文档整理流程。一、这次迁移改变了什么NOFX 将原先散落在仓库根目录的 Markdown 文档统一收纳进结构化的docs/目录以提升组织度与可导航性。这是一次纯文档工程层面的重构不涉及运行时行为变更代码、配置与启动方式均不受影响但所有指向被移动文件的链接书签、外部文档引用、README 内部链接都需要按新路径更新。从当前仓库的实际状态看这次重组已经落地根目录仅保留平台识别所需的少量文件而docs/下已按getting-started/、guides/、community/、i18n/、architecture/等分类目录组织文档导航枢纽位于 docs/README.md。二、文件位置映射旧 → 新迁移的核心是一张新旧位置对照表原文档中被移动的文件全部可以按此表定位到新路径部署指南Deployment Guides旧位置新位置DOCKER_DEPLOY.en.mddocs/getting-started/下 Docker 部署指南英文DOCKER_DEPLOY.mddocs/getting-started/下 Docker 部署指南中文CUSTOM_API.mddocs/getting-started/custom-api.md社区文档Community Docs旧位置新位置HOW_TO_POST_BOUNTY.mddocs/community/bounty-guide.mdINTEGRATION_BOUNTY_HYPERLIQUID.mddocs/community/bounty-hyperliquid.mdINTEGRATION_BOUNTY_ASTER.mddocs/community/bounty-aster.md国际化文档Internationalization旧位置新位置README.zh-CN.mddocs/i18n/zh-CN/README.mdREADME.ru.mddocs/i18n/ru/README.mdREADME.uk.mddocs/i18n/uk/README.md常见问题.mddocs/guides/faq.zh-CN.md保留在根目录Root Directory, Unchanged以下文件因平台识别机制必须留在根目录不做迁移README.md✅ 项目主页LICENSE✅ 开源许可证CONTRIBUTING.md✅ 贡献指南平台自动识别CODE_OF_CONDUCT.md✅ 社区行为准则平台自动识别SECURITY.md✅ 安全策略平台自动识别从仓库现状可以验证这一设计根目录确实只保留了README.md、LICENSE、CONTRIBUTING.md、CODE_OF_CONDUCT.md、SECURITY.md外加CHANGELOG.md、Makefile、go.mod等项目必要文件不再有大量语言后缀的文档散落。三、为什么要重构Before/After 对比重构前问题❌nofx/ ├── README.md ├── README.zh-CN.md ├── README.ru.md ├── README.uk.md ├── DOCKER_DEPLOY.md ├── DOCKER_DEPLOY.en.md ├── CUSTOM_API.md ├── HOW_TO_POST_BOUNTY.md ├── INTEGRATION_BOUNTY_HYPERLIQUID.md ├── INTEGRATION_BOUNTY_ASTER.md ├── 常见问题.md └── ... (15 markdown files in root!)对应的问题清单根目录文件过多15 个 Markdown 文件视觉上非常杂乱具体文档难以定位检索成本高多语言文件混排缺少统一的语言组织没有清晰的分层分类扩展性差重构后收益✅nofx/ ├── README.md # 项目主页 ├── LICENSE # 法律文件平台要求位于根目录 ├── CONTRIBUTING.md # 贡献指南平台自动链接 ├── CODE_OF_CONDUCT.md # 社区准则平台自动链接 ├── SECURITY.md # 安全策略平台自动链接 │ └── docs/ # 文档枢纽 ├── README.md # 文档首页 ├── getting-started/ # 部署与安装指南 ├── guides/ # 使用指南 ├── community/ # 贡献与悬赏文档 ├── i18n/ # 多语言翻译 └── architecture/ # 技术架构文档重构带来的收益根目录干净整洁文档按主题逻辑分类导航路径清晰直观结构可扩展新增分类成本低整体观感更专业四、新的文档目录结构详解根目录层保留平台必须识别的元文件这是开源仓库的通用惯例——平台会基于根目录的README.md、LICENSE、CONTRIBUTING.md、CODE_OF_CONDUCT.md、SECURITY.md自动渲染项目主页、许可证信息与贡献入口。docs/ 层docs/README.md文档中心所有文档的第一入口提供分类索引与快速导航。仓库中的实际内容包含快速开始、使用指南、社区与贡献、国际化、架构与开发、路线图、法律与政策等板块并用中英双语表格组织。分类目录getting-started/—— 部署与安装Docker 部署指南英文/中文自定义 AI API 配置custom-api.md、custom-api.en.md当前仓库还扩展了各交易所接入说明币安binance-api.md、Bybitbybit-api.md、OKXokx-api.md、Hyperliquidhyperliquid-agent-wallet.md、Aster、Lighter 等实际分类粒度比迁移初期的规划更细guides/—— 使用指南与教程常见问题faq.zh-CN.md、faq.en.md故障排查TROUBLESHOOTING.zh-CN.md、TROUBLESHOOTING.md迁移计划中的 planned 状态已实现配置示例规划中community/—— 贡献与悬赏悬赏任务指南bounty-guide.md进行中的悬赏任务Hyperliquid 集成bounty-hyperliquid.md、Aster DEX 集成bounty-aster.md贡献者认可机制迁移后进一步补充了 PR 迁移指南HOW_TO_MIGRATE_YOUR_PR.md、迁移公告MIGRATION_ANNOUNCEMENT.md与官方账号防冒认说明OFFICIAL_ACCOUNTS.mdi18n/—— 国际化翻译简体中文zh-CN/、俄语ru/、乌克兰语uk/当前仓库实际已扩展到 7 种语言英文、中文、日文ja/、韩文ko/、俄语、乌克兰语、越南语vi/每种语言目录下均含 README 及隐私政策、服务条款等文档见 docs/i18n/README.mdarchitecture/—— 技术文档系统设计规划中实际已补充架构总览 architecture/README.mdAPI 参考已落地为 docs/api/API_REFERENCE.md数据库结构规划中五、更新链接的正确姿势书签与外部引用如果你收藏了旧链接需要按下表同步更新旧链接新链接DOCKER_DEPLOY.en.mddocs/getting-started/下对应部署指南README.zh-CN.mddocs/i18n/zh-CN/README.mdHOW_TO_POST_BOUNTY.mddocs/community/bounty-guide.md自己文档中的相对链接以文档为基准的相对链接必须重写为以仓库根目录为起点的路径。原文档给出的标准改写范例!-- 旧写法相对文档自身位置迁移后失效 -- Docker Deployment !-- 新写法以仓库根目录为起点稳定可解析 -- Docker Deployment这条规则也是本仓库当前所有文档实际遵循的规范以docs/README.md为例其指向根级文件的链接写作../README.md、../CONTRIBUTING.md指向同层级文件的链接直接使用getting-started/README.md形式——换算为仓库根目录相对路径后都能正确解析。平台自动重定向托管平台对文件移动git mv被 Git 追踪通常会保留旧路径的访问并自动重定向到新路径例如旧地址仓库地址/blob/main/DOCKER_DEPLOY.en.md会自动跳转到新的docs/getting-started/位置。这意味着外部书签可能仍然可用但重定向只是兼容性保障长期稳定引用仍应优先使用新路径。六、贡献者操作指南拉取最新代码# 拉取 dev 分支最新变更 git pull origin dev # 旧书签仍然有效 # Git 通过 git mv 追踪了文件移动由于迁移使用git mv完成Git 能正确追踪文件的移动历史git pull后本地工作区会自动对齐新的目录结构不必手动处理文件搬移。查找文档推荐从导航中心 docs/README.md 进入按分类浏览也可以直接用命令行检索# 列出所有 Markdown 文档 find docs -name *.md # 按关键词搜索内容 grep -r keyword docs/新增文档遵循目录结构放置# 部署类指南 docs/getting-started/your-guide.md # 使用类教程 docs/guides/your-tutorial.md # 社区类文档 docs/community/your-doc.md # 翻译文档以日语为例 docs/i18n/ja/README.md同步更新导航在对应分类的 README 中补充链接并在 docs/README.md 主枢纽登记新条目确保文档可从导航中心直达。提交信息规范原重组提交的 Commit Message 可作为文档类变更的模板docs: reorganize documentation into structured docs/ directory - Move deployment guides to docs/getting-started/ - Move community docs to docs/community/ - Move translations to docs/i18n/ - Create navigation hub at docs/README.md - Update all internal links in README.md - Add GitHub issue/PR templates BREAKING CHANGE: Direct links to moved files will need updating (though GitHub redirects should work) Closes #XXX其中两点值得注意docs:前缀遵循 Conventional Commits 约定docs类型专用于文档变更BREAKING CHANGE声明尽管平台会自动重定向旧链接但直链仍可能失效因此在提交说明中明确标注破坏性变更提醒使用者更新链接。仓库的 PR 管理相关文档如 docs/community/HOW_TO_MIGRATE_YOUR_PR.md同样沿用了docs(...)类型的提交约定二者互相印证。七、找不到文档或链接失效怎么办首先检查 docs/README.md 导航中心按分类逐项查找其次在仓库内搜索grep -r或平台的搜索功能如果链接仍然失效通过仓库 Issues 反馈维护者会尽快修复想贡献文档可先阅读 CONTRIBUTING.md 了解提交流程并参考 docs/community/README.md 中的贡献与悬赏规则。八、迁移元信息迁移日期2025-11-01维护者Tinkle Community本次重组后文档体系的演进并未停止从当前仓库状态看docs/下已陆续新增了api/、maintainers/、plans/、research/、roadmap/、legal/等新分类以及market-regime-classification、prompt-guide、pnl、token-estimation等技术文档——这说明按主题分类、可横向扩展的目录设计经受住了实际演进正是当初重构所追求的结构收益。赞分享AI Agent金融科技后端前端【免费下载链接】nofxYour AI trading terminal assistant for US stocks, commodities, forex, and crypto.项目地址https://gitcode.com/gh_mirrors/nof/nofx点击查看免费下载相关推荐NOFX 开源贡献实战指南新版 PR 管理系统迁移与提交规范全解析NOFX 开源贡献实战指南新版 PR 管理系统迁移与提交规范全解析 本篇技术指南面向所有希望向 NOFX 提交代码的贡献者与维护者系统讲解该项目引入的新版AI Agent金融科技后端前端NOFX 贡献者 PR 迁移实战指南同步 Rebase、代码质量检查与 Conventional Commits 标题规范NOFX 贡献者 PR 迁移实战指南同步 Rebase、代码质量检查与 Conventional Commits 标题规范 本文基于 NOFX 项目新的 PRAI Agent金融科技后端前端EIPs 仓库贡献指南作者、贡献者与编辑者的协作规范与实践EIPs 仓库贡献指南作者、贡献者与编辑者的协作规范与实践 本指南基于 Ethereum Improvement ProposalsEIPs开源仓库的 C区块链文档Web3创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考