跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.nexfi.robert.dpdns.org/llms.txt

Use this file to discover all available pages before exploring further.

​
快速开始

本页用于说明文档入口和整体组织方式，方便研发、产品和联调人员快速找到正确内容。

​
按模块阅读

如果你在看业务流程或产品能力，优先阅读模块说明页：
  • 钱包
  • 跨链桥
  • 质押
  • 量化
这些页面偏向人类阅读，重点说明：
  • 接口用途
  • 入参和出参的业务含义
  • 示例请求和示例响应
  • 业务规则与产品语义

​
按接口契约阅读

如果你在做前后端联调、字段核对或接口查阅，直接进入 API Reference：
  • 钱包 API 参考
  • 跨链桥 API 参考
  • 质押 API 参考
  • 量化 API 参考
这些内容由 OpenAPI 文件驱动生成，目录位于： 
mintlify/openapi/
mintlify/openapi/zh/

​
双语目录结构

当前文档站支持英文和中文：
  • 英文说明页在 mintlify/
  • 中文说明页在 mintlify/zh/
  • 英文 OpenAPI 在 mintlify/openapi/
  • 中文 OpenAPI 在 mintlify/openapi/zh/
导航配置统一维护在： 
mintlify/docs.json

​
说明页与 API Reference 的分工

文档分为两层：
  1. MDX 说明页 用于解释业务背景、接口用途、字段语义、典型场景和示例。
  2. OpenAPI 生成页 用于查看接口契约、schema、请求体、响应体和字段说明。
维护原则：
  • 如果接口语义、字段或示例发生变化，MDX 和 OpenAPI 都要更新。
  • 如果只是 API Reference 展示不够细，优先补 OpenAPI 中的 description 和 example。

​
按角色建议入口

如果你在做 App 或业务接入：
  • 钱包
  • 跨链桥
  • 质押
如果你在做量化系统或策略管理：
  • 量化概览
  • 量化策略与执行
  • 量化研究对象
如果你在维护文档站：
  • 本地开发
  • mintlify/README.md