DOC-302d 更新技术文档为 proc-macro 模式 #33

New Issue

wangdl · 2026-06-02T22:19:19+08:00

wangdl commented

2026-06-02 22:19:19 +08:00

目标

将全部技术文档从 UDL 模式描述更新为 proc-macro 模式。

需要更新的文件

README.md

7.1 Core 基础依赖：补 uniffi 到推荐依赖
7.8 UniFFI：改写为 proc-macro 模式说明（✅ 已完成）
1. crates/zx_document_ffi 职责描述（✅ 已完成）

docs/architecture.md

分层架构图：UniFFI C-ABI bridge → UniFFI proc-macro C-ABI bridge
FFI 绑定行：补充 proc-macro 说明

docs/ios-integration.md

第 2 节：Swift Binding 生成步骤从 UDL 改为 library 模式（✅ 已完成）
常见问题表：补充 library 模式相关 FAQ

docs/app-rust-bridge.md

函数签名从伪代码更新为实际 Rust 函数签名
补充 proc-macro 导出说明

依赖

无（独立文档任务，可与 302a/b/c 并行）

验收

所有文档与 proc-macro 模式一致
新开发者按文档操作可完成 iOS 集成

## 目标将全部技术文档从 UDL 模式描述更新为 proc-macro 模式。 ## 需要更新的文件 ### README.md - 7.1 Core 基础依赖：补 `uniffi` 到推荐依赖 - 7.8 UniFFI：改写为 proc-macro 模式说明（✅ 已完成） - 8. crates/zx_document_ffi 职责描述（✅ 已完成） ### docs/architecture.md - 分层架构图：`UniFFI C-ABI bridge` → `UniFFI proc-macro C-ABI bridge` - FFI 绑定行：补充 proc-macro 说明 ### docs/ios-integration.md - 第 2 节：Swift Binding 生成步骤从 UDL 改为 library 模式（✅ 已完成） - 常见问题表：补充 library 模式相关 FAQ ### docs/app-rust-bridge.md - 函数签名从伪代码更新为实际 Rust 函数签名 - 补充 proc-macro 导出说明 ## 依赖 - 无（独立文档任务，可与 302a/b/c 并行） ## 验收 - 所有文档与 proc-macro 模式一致 - 新开发者按文档操作可完成 iOS 集成

wangdl added this to the M3：iOS 主 App 资料阅读闭环 milestone 2026-06-02 22:19:19 +08:00

wangdl added the

type:docs

area:architecture

labels 2026-06-02 22:19:19 +08:00

wangdl commented

2026-06-03 20:02:30 +08:00

完成 (2026-06-03)

已更新文件

文件	改动
README.md §7.8	改为 proc-macro 模式说明 + 版本注意事项
README.md §8	FFI crate 职责更新
docs/architecture.md	分层图 + crate 表 + FFI 描述更新为 proc-macro
docs/ios-integration.md §2	改为 UDL bindgen + proc-macro 混合模式步骤
docs/app-rust-bridge.md	全部 12 个函数签名改为实际实现（移除未实现的 DocumentHandle 概念）

文档一致性验证

所有文档描述的方式与实际构建流程一致
UDL → Swift bindgen：类型 + 函数封装
#[uniffi::export] → proc-macro → C ABI 符号
build-ios.sh → 自动化两步 + 符号检查

## 完成 (2026-06-03) ### 已更新文件 | 文件 | 改动 | |---|---| | README.md §7.8 | 改为 proc-macro 模式说明 + 版本注意事项 | | README.md §8 | FFI crate 职责更新 | | docs/architecture.md | 分层图 + crate 表 + FFI 描述更新为 proc-macro | | docs/ios-integration.md §2 | 改为 UDL bindgen + proc-macro 混合模式步骤 | | docs/app-rust-bridge.md | 全部 12 个函数签名改为实际实现（移除未实现的 DocumentHandle 概念） | ### 文档一致性验证 - 所有文档描述的方式与实际构建流程一致 - UDL → Swift bindgen：类型 + 函数封装 - #[uniffi::export] → proc-macro → C ABI 符号 - build-ios.sh → 自动化两步 + 符号检查

wangdl closed this issue

2026-06-07 20:06:44 +08:00

wangdl commented

2026-06-07 20:06:44 +08:00

关闭

DOC-302d 已完成 — docs 目录已有 7 份技术文档

## 关闭 DOC-302d 已完成 — docs 目录已有 7 份技术文档

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: wangdl/zhixi-document-runtime#33