docs

Yunba Documentation

文档风格

• 文档采用 github 兼容 markdown 格式编写。
• 中英文中间要加空格，遇到标点、斜杠等字符时可以省略空格。例如：“Yunba 实时消息、Yunba 的 Android/iOS 消息推送。”
• 中英文标点不要混用。中文文档内容统一使用中文标点，英文文档统一使用英文标点。
• 专用名词统一。特别是中英文翻译，使用统一的对照表。
• API 输入参数使用表格描述。
• 文档的图片使用 github URL：https://raw.githubusercontent.com/yunba/docs/master/image/xxx.png

文档文件名命名规则

• 文档的文件名由模块名、文档类型组成。
• 文件名各个部分用 "_" 连接。

例如：Android_QuickStart.md

文档目录结构

1. 产品介绍 ［/products］

• 产品简介 [/products/product_briefing.md]
• 消息推送概述 [/products/briefing_push_notification.md]
• 实时消息概述 [/products/briefing_realtime_messaging.md]
• 实时统计概述 [/products/briefing_analytics.md]
• 实时在线概述 [/products/briefing_presence.md]

2. 开发指南 ［/tutorials］

• 消息推送开发指南 [/tutorials/tutorials_push_notification]

• 消息推送开发指南之 Android 篇[/tutorials/tutorials_push_notification/tutorials_push_notification_Android.md]
• 消息推送开发指南之 iOS 篇[/tutorials/tutorials_push_notification/tutorials_push_notification_iOS.md]
• 消息推送开发指南之 C 篇[/tutorials/tutorials_push_notification/tutorials_push_notification_C.md]
• 消息推送开发指南之 JavaScript 篇[/tutorials/tutorials_push_notification/tutorials_push_notification_JavaScript.md]
• 消息推送开发指南之 Socket.io 篇[/tutorials/tutorials_push_notification/tutorials_push_notification_SocketIO.md]
• 消息推送开发指南之 RESTful 篇[/tutorials/tutorials_push_notification/tutorials_push_notification_RESTful.md]

• 实时消息开发指南 [/tutorials/tutorials_realtime_messaging.md]
• 实时统计开发指南 [/tutorials/tutorials_analytics.md]
• 实时在线开发指南 [/tutorials/tutorials_presence.md]

3. 快速入门 [/quickstart]

• 运行 Yunba SDK Demo [/quickstart/demo]

• 运行 Yunba Android Demo [/quickstart/demo/Android.md]
• 运行 Yunba iOS Demo [/quickstart/demo/iOS.md]

4. SDK 手册 [/sdk]

5. 技术支持 [/support]

• FAQ [/support/faq.md]
• 知识库 [/support/knowledge_base]
• 更新日志 [/support/change_log.md]
• 技术博客 [/support/blog]
• 开发论坛 [/support/forum]

6. 案例分析 [/demos]