Files
AtomUI/docs/overview.md
T

4.7 KiB
Raw Blame History

AtomUI 文档

AtomUI 文档按知识责任组织。跨模块系统设计、单个源码模块、具体 Control、工程规范、Gallery 和过程记录分别维护, 同一稳定契约只由一份正式文档拥有。

阅读入口

  • 整体架构:系统分层、源码包边界和核心运行链路。
  • 架构基础:项目依赖、运行平台、启动注册、构建和打包。
  • 跨模块系统:主题、字体、本地化、统一图片加载、Control 基础设施和渲染系统的统一入口。
  • 源码模块:按源码项目或发布包理解职责和实现边界。
  • Control 文档:按平台和类别查看具体 Control 的设计、实现、Token 和变更。
  • 使用指南:按任务查看主题定制与后续接入指南。
  • Reference:版本化格式、协议和稳定公共契约。
  • 工程规范:开发、AOT、诊断、文档、测试和发布规则。
  • Gallery 文档:Gallery 组织、ShowCase 和平台维护说明。
  • Releases:按版本查看 API 变化与迁移示例。
  • Strategy:产品与产业战略分析。
  • Superpowers:设计过程、实施计划和阶段进度,不作为正式架构的事实来源。

文档职责

docs/
|-- overview.md
|-- architecture/   # 跨模块当前架构与带统一状态声明的预实现架构
|-- modules/        # 单个源码项目或发布包
|-- controls/       # 单个 Control 或紧密 Control 家族
|-- guides/         # 面向任务的使用和接入指南
|-- reference/      # 版本化格式、协议和公共契约
|-- engineering/    # 开发规范、工作流和检查清单
|-- gallery/        # AtomUIGallery 工程文档
|-- releases/       # 版本 API 变化
|-- strategy/       # 产品与产业战略分析
|-- AI/             # AI 工具消费层和配置驱动的生成文档
`-- superpowers/    # 设计与实施过程记录

modules/ 与 controls/ 的边界必须保持清楚:模块文档解释包如何组织、注册和加载;Control 文档解释具体控件的 公共契约、行为、模板、Token 和维护不变量。

当前专题

Mobile 预实现入口

状态:预实现架构。本文定义已批准的目标契约,不表示当前仓库已经包含或发布 AtomUI.Mobile.Controls。

Mobile 目标与当前 Desktop 源码结构分开表达。现有 AtomUI.Toolkits.GalleryBase 不自动成为 Mobile Foundation 依赖或输出。

随着专题完成职责迁移,本入口同步切换到新的 Architecture、Guide、Reference 或 Module 路径,不保留重复副本。