跳到主要内容

ViewCompose 文档

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

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

选择阅读路径​

目标建议入口
构建第一个应用构建第一个应用
学习某一项能力能力教程 → 任意选择主题，章节之间没有顺序要求
理解框架架构总览 → 多设计系统标准 → Modifier 模型 → NodeSpec 模型
从 Jetpack Compose 迁移Compose 迁移总览 → 按状态、布局、宿主或导航选择迁移路径
选择或维护已发布产物已发布模块目录 → 对应模块手册
查找面向应用的入口能力参考 → 版本化 API/KDoc → 对应模块手册
使用某项能力从下面的指南中选择对应主题
连接 AI AgentAI 接入
使用预览、诊断或进行性能工作预览 → 诊断 → 性能
参与贡献开发流程 → 文档治理规范
准备发布发布流程 → 能力验证
恢复项目上下文阅读路线图和对应领域的有效文档，不要从归档计划开始

架构​

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

教程​

每项能力对应一个可编译源码文件，而且可以独立运行：

  • 构建第一个应用——构建最小的原生 View 计数器和可选静态 Preview。
  • 能力教程目录——无需先完成其他章节，直接选择状态、布局、文本输入、 Lazy 列表、主题、导航、Overlay、Android View 互操作、动画、手势、性能或诊断。

指南​

功能行为和平台集成：

从 Jetpack Compose 迁移​

明确标注源版本和目标版本的语义对比与迁移路径：

已发布模块​

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

能力与 API 参考​

从源码派生的能力参考按用户能力组织面向应用的 DSL、Modifier、组件、集成、宿主 和工具入口，数量、版本与路由都受新鲜度门禁保护。完整签名和 KDoc/Javadoc 请查看 版本化 API Reference，再通过入口中的模块手册链接了解产物契约。

AI 接入​

机器可读 Reference、本地 MCP 工具、标准 Agent Skill 与可执行证据：

工具​

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

项目维护​

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

文档规则​

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

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