关于产品文档中心
本站致力于为使用者提供统一、可信的产品文档，包括入门指南、核心概念、API 参考、教程与最佳实践。
我们的目标
- 帮助你快速上手，降低学习与对接成本
- 提供结构化、可搜索的知识库，提升信息获取效率
- 保障文档可维护、可协作，不断演进与完善
适用人群
- 开发者：对接 SDK、调用 API、集成产品能力
- 运维与测试：理解系统架构与运行机制，进行部署与验证
- 产品与技术写作者：编写、维护与优化文档内容
核心能力
- MDX 文档：支持 Markdown 与 React 组件，代码高亮与示例演示
- 全文搜索与清晰导航：快速定位到所需信息
- 编辑与反馈入口：页面右上角提供 “Edit this page on GitHub” 与反馈按钮
- 主题与样式可定制：支持暗色模式与品牌化风格
- 静态导出与易部署：适合在多种平台进行托管与发布
文档结构
- 入门指南：
/getting-started/installation，/getting-started/quick-start - 核心概念：
/core-concepts/architecture - API 参考：
/api-reference/authentication - 教程：
/tutorials - 示例：
/examples - 功能总览：
/features - 高级专题：
/advanced/satori - 常见问题：
/faq
快速上手
- 从 “Getting Started” 开始安装与启动本地环境。
- 使用左侧导航或右上角搜索快速定位主题。
- 若页面内容需要改进，点击右上角 “Edit this page on GitHub” 进行编辑，或通过 “Questions? Give us feedback” 提交反馈。
写作规范（简要）
- 标题层级清晰（
#、##、###），段落简洁、术语统一。 - 每页聚焦一个主题，避免过长；必要时拆分为子页面。
- 示例代码可运行或贴近真实场景；接口文档包含请求与响应样例。
- 链接尽量使用站内相对路径（如
/api-reference/authentication）。 - 图片与静态资源放置在
public/目录下。
构建与发布
- 开发模式：
npm run dev（热更新） - 生产构建：
npm run build - 站点支持静态导出与多平台托管
联系与支持
- 使用页面右上角的反馈入口提交问题或建议。
- 通过页面上的编辑链接（Edit this page on GitHub）发起内容改进。