63 行
2.5 KiB
Markdown
63 行
2.5 KiB
Markdown
|
# RN 对外文档边界
|
||
|
|
|
||
|
|
## 目的
|
||
|
|
|
||
|
|
`docs-site/docs/rn/` 是面向宿主集成方的公开文档，只描述安装、配置、公开 API、宿主交互、
|
||
|
|
错误处理、平台差异和可执行的排障步骤。内部设计继续保留在对应 SDK 仓库，不进入公开
|
||
|
|
站点导航、搜索索引或示例。
|
||
|
|
|
||
|
|
## 事实来源
|
||
|
|
|
||
|
|
文档修改按以下优先级核对：
|
||
|
|
|
||
|
|
1. `XuqmGroup-RNSDK/packages/*/src/index.ts` 的真实公开导出。
|
||
|
|
2. 公开类型定义和公开对象方法。
|
||
|
|
3. 当前测试、可运行示例和构建脚本。
|
||
|
|
4. 租户平台当前实际提供的配置与功能。
|
||
|
|
|
||
|
|
包内 README、历史文档、注释和旧站点内容只能作为线索，不能直接复制到公开站点。
|
||
|
|
|
||
|
|
## 当前公开模块
|
||
|
|
|
||
|
|
- `@xuqm/rn-common`
|
||
|
|
- `@xuqm/rn-update`
|
||
|
|
- `@xuqm/rn-bugcollect`
|
||
|
|
- `@xuqm/rn-xwebview`
|
||
|
|
- `@xuqm/rn-im`
|
||
|
|
- `@xuqm/rn-push`
|
||
|
|
|
||
|
|
未实现、未发布或没有稳定公开契约的模块和 API 不得预先出现在文档站。
|
||
|
|
|
||
|
|
## 可以公开
|
||
|
|
|
||
|
|
- 安装依赖和只读制品仓库。
|
||
|
|
- 平台配置文件的下载位置与宿主放置方式。
|
||
|
|
- 自动配置、公共登录和隐私授权的调用方式。
|
||
|
|
- 宿主需要调用的公开 API、参数、返回状态和错误码。
|
||
|
|
- Android/iOS 已验证范围及权限、Manifest、Info.plist 要求。
|
||
|
|
- 插件化的创建、打包、上传和宿主调用方式。
|
||
|
|
- 不涉及安全实现的默认行为、升级说明与排障清单。
|
||
|
|
|
||
|
|
## 禁止公开
|
||
|
|
|
||
|
|
- 官方扩展包专用的 internal 子路径和内部聚合包。
|
||
|
|
- 配置解密、签名算法、可信密钥、不可变清单和校验实现。
|
||
|
|
- 插件安装事务、内部状态表、回滚存储和版本规划算法。
|
||
|
|
- 数据库选型、表结构、用户隔离键和内部缓存格式。
|
||
|
|
- 服务拓扑、内部接口、内部令牌、私有化部署脚本和运维地址。
|
||
|
|
- App4、医网信或其他单一宿主的页面、厂商、域名和业务协议。
|
||
|
|
- 凭据、Token、配置文件正文、用户隐私数据和真实业务响应。
|
||
|
|
- 没有源码依据的示例 API。
|
||
|
|
|
||
|
|
## 自动检查
|
||
|
|
|
||
|
|
`yarn workspace @xuqm/docs-site check:rn-contract` 检查：
|
||
|
|
|
||
|
|
- 十个 RN 公开页面和导航完整性。
|
||
|
|
- 六个公开包是否均有入口。
|
||
|
|
- 历史 API、internal 入口和内部实现词汇。
|
||
|
|
- 在本地多仓工作区中，文档命名导入和对象方法是否确实由当前 RN SDK 源码公开。
|
||
|
|
|
||
|
|
文档站构建前自动执行同一检查。Jenkins 单仓构建无法读取兄弟 SDK 仓库时仍执行静态
|
||
|
|
边界检查；合并前必须在完整本地工作区至少执行一次源码增强检查。
|
