跳到主要内容

ViewCompose 文档

这里是 ViewCompose 的权威文档入口。文档同时面向人工阅读和 AI 辅助维护,也是 GitHub 托管文档站点的内容边界。

仓库当前状态和下面列出的有效文档才是权威信息。archive/ 下的文件仅作为历史记录。

选择阅读路径

目标建议入口
理解框架架构总览Modifier 模型NodeSpec 模型
选择或维护已发布产物已发布模块目录 → 对应模块手册
使用某项能力从下面的指南中选择对应主题
使用预览或进行性能工作预览诊断性能
参与贡献开发流程文档治理规范
准备发布发布流程能力验证
恢复项目上下文阅读路线图和对应领域的有效文档,不要从归档计划开始

架构

长期有效的契约、边界和运行时语义:

指南

功能行为和平台集成:

已发布模块

已发布模块目录与 Maven 发布元数据保持同步。独立模块手册将放在 docs/modules/<artifact-id>/ 下,并可随对应产物独立演进。

工具

开发期工具、检查和性能能力:

项目维护

当前流程、发布和规划信息:

文档规则

  1. 仓库根目录只保留入口页和社区治理文件。
  2. 区分跨模块概念与单个产物的依赖、兼容性和 API 契约。
  3. 公开 API 变化必须同步更新 KDoc/Javadoc 和对应模块手册。
  4. 每个代码 PR 都要应用文档影响矩阵;选择“无文档影响”时必须说明理由。
  5. 跨会话执行计划放在 docs/project/plans/,完成后移动到 docs/archive/
  6. 使用仓库相对链接,禁止提交本地绝对路径。
  7. 每份有效文档都必须能从本索引沿链接访问。
  8. 不得把归档文档当作当前需求。
  9. 提交文档前运行 ./gradlew verifyDocumentationStructureqaQuick 也包含该检查。
  10. 修改已翻译的公开内容时遵循本地化工作流,不得在未审阅 语义的情况下只刷新翻译指纹。

完整契约、命名规则、生命周期和审查清单位于 文档治理规范