README.md

React Native for OpenHarmony 开发者文档

本文档适合具有 React Native 基础的开发者使用。在阅读前,建议先学习 React Native 官方文档

开发者旅程导航

旅程阶段 目录 核心内容
📐 设计 01-设计 接口规格、架构规划、通信机制
💻 开发 02-开发 环境搭建、功能开发、组件定制
🔍 调测 03-调测 调试方法、问题定位、FAQ
⚡ 调优 04-调优 性能优化、实践案例
🔧 运维 05-运维 版本管理、稳定性管理、构建打包
🌐 社区 06-社区 社区规范、共建指南

目录结构

docs/zh-cn/
│
├── 01-设计/                        # 设计阶段
│   ├── 框架介绍.md                  # RNOH 整体介绍
│   ├── 架构介绍.md                  # 技术架构详解
│   ├── 渲染三阶段.md                # 渲染流程原理
│   ├── ArkTS与CPP之间通信.md        # Native通信机制
│   ├── 两端通讯.md                  # JS-Native通信
│   ├── API接口说明.md               # 接口规格文档
│   ├── 规格类FAQ.md                 # 规格相关问题
│   └── README.md
│
├── 02-开发/                        # 开发阶段
│   ├── 01-环境与工具/               # 环境与工具 ⚡版本相关
│   │   ├── 环境搭建.md              # 开发环境配置
│   │   ├── SDK版本配置指导.md       # SDK版本选择
│   │   └── 示例工程索引.md          # 示例工程列表
│   ├── 02-开发指南/                 # 开发指南
│   │   ├── 功能开发.md              # 开发流程指南
│   │   ├── 自定义组件.md            # 组件开发指南
│   │   ├── Codegen.md               # 代码生成工具
│   │   ├── TurboModule.md           # TurboModule使用
│   │   ├── Autolinking.md           # 自动链接配置 ⚡版本相关
│   │   ├── RN-Native接入.md         # Native接入方案
│   │   ├── C-API组件混合方案的使用.md # C-API混合方案
│   │   └── 编译构建/
│   │       ├── 编译构建指南.md
│   │       └── RNOH构建与符号管理工程级指南.md
│   ├── 03-场景与实践/               # 场景与实践
│   │   ├── 常见开发场景.md          # 场景化开发指南
│   │   ├── RN应用鸿蒙化开发指南.md  # RN应用鸿蒙化开发全流程指南
│   │   ├── 场景化最佳实践.md        # 最佳实践案例
│   │   └── 使用类FAQ.md             # 开发相关问题
│   └── README.md
│
├── 03-调测/                        # 调测阶段
│   ├── 调试调测.md                  # 调试工具与方法
│   ├── FAQ.md                       # FAQ总览
│   ├── 编译类FAQ.md                 # 编译问题排查
│   ├── 运行类FAQ.md                 # 运行问题排查
│   ├── 定位定界指导类FAQ.md         # 问题定位方法
│   └── README.md
│
├── 04-调优/                        # 调优阶段
│   ├── 性能调优.md                  # 性能优化指南
│   ├── 内存优化指导.md              # 内存优化指导
│   └── 性能优化实践/
│       └── 页面转场与滑动场景优化.md
│   └── README.md
│
├── 05-运维/                        # 运维阶段 ⚡版本相关
│   ├── 版本说明.md                  # 版本说明文档
│   ├── 版本升级指导.md              # 版本升级指南
│   ├── RN升级需要开发者适配整理.md  # RN升级适配清单
│   ├── 上游社区不兼容变更.md        # 上游变更说明
│   ├── RN-JS打包.md                 # JS打包指南
│   ├── hvigorfile配置.md            # 构建配置说明
│   ├── 多屏适配指导.md              # 部署适配
│   ├── AI辅助问题定位指导.md        # AI定位工具
│   ├── release-notes/               # 版本发布说明
│   ├── 稳定性历史修复/              # 稳定性修复汇总
│   ├── 稳定性编码规范/              # 稳定性编码规范
│   │   └── 稳定性编码规范.md
│   ├── 稳定性skill/                 # 稳定性分析工具
│   │   ├── rnoh-stability-review/
│   │   └── rnoh-stability-triage/
│   ├── 稳定性问题介绍/              # 稳定性问题介绍
│   │   ├── 稳定性概览.md
│   │   ├── 稳定性分析方法.md
│   │   └── 稳定性案例.md
│   └── README.md
│
├── 06-社区/                        # 社区治理
│   ├── 开发者文档共建指南.md        # 文档共建规范
│   ├── roadmap.md                   # 社区路线图
│   ├── 社区规范/
│   │   ├── 社区issue管理规范.md
│   │   ├── 社区commit和pr规范.md
│   │   ├── 社区changelog规范.md
│   │   ├── 仓库分支管理规范.md
│   │   ├── rnoh包管理规范.md
│   │   └── 开发者共建指南.md
│   └── README.md
│
├── figures/                        # 图片资源
└── public_sys-resources/           # 公共资源

⚡ 标记为「版本相关」的文档,随版本发布需同步更新


外部资源


版本分类说明

类型 目录 维护策略
版本相关 02-开发/01-环境与工具(环境/SDK)、02-开发/02-开发指南(Autolinking)、05-运维(版本管理/稳定性历史修复) 随版本发布同步更新
版本无关 01-设计、03-调测、04-调优、05-运维(稳定性编码规范/稳定性skill/稳定性问题介绍)、06-社区 独立维护,长期有效

贡献指南

参与文档共建请阅读 开发者文档共建指南

发版后维护整个 docs/ 版本号时,请使用 文档版本同步 Skill(对话中 @docs/rnoh-docs-version-upgrade/SKILL.md)。