• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Docs仓MD文档PR信息
2
3> **注意:**
4> 请务必按如下模板反馈PR所携带的修改信息。
5> 请分析是否需要同步合入活跃的发布分支。当前活跃的分支除master外还包括:
6> (API 20 Beta2) weekly_20250707
7> (API 19) OpenHarmony-feature-20250512
8
9## 文档变更类型
10
11请描述本次文档更新类型(原因),**请在对应类型的括号内填写Y**:
12- 新增需求( )
13- 变更需求( )
14- VOD修复( )
15- 主动优化( )
16
17## API参考更新的关联PR
18
19如涉及API参考的更新,应当同步提供interface仓d.ts文件的变更PR。
20
21不涉及请反馈NA。
22
23## 文档更新内容自检
24
25为确保文档合入质量,请遵循如下要求完成基础质量自检Checklist,**并在自检项后的括号内填写Y**:
26
27- 文档中示例代码片段已经在IDE中自验证,确保编译通过,并在下方给出截图证明。( )
28- API的定义与使用方式与配套版本的SDK严格一致,无文档与SDK不一致问题。( )
29- 文档需完成[AI辅助工具DocLinter扫描](https://gitcode.com/openharmony/docs/wiki/HarmonyPilot-DocLinter_AI%E8%BE%85%E5%8A%A9%E5%86%99%E4%BD%9C%E6%8F%92%E4%BB%B6.md)并完成问题修改,并在此附加在线扫描报告的链接。
30
31## 示例代码编译通过截图证明(如涉及示例代码需提供):
32
33> **说明:**
34> 1. 示例代码验证时,应尽可能**在有效设备上实际运行**。仅编译或IDE预览器运行均无法发现所有潜在问题。
35> 2. 示例代码截图应提供**编译日志**和**运行日志**以证明示例代码无问题。**存在错误码但不阻塞编译的日志均视为示例代码有误**。