mirror of
https://github.com/AtomUI/AtomUI.git
synced 2026-10-25 02:30:32 +08:00
chinboy
9f6ec36645
统一文档目录的入口文件名为 `overview.md`，取代原先的 `index.md`。单 Control 目录本来就用 `overview.md`，此前只有目录级入口用 `index.md`，两套命名并存；现在全库一致。 改名覆盖 42 个入口文件：`docs/` 根、一级分类目录、Architecture 分组与跨模块系统目录、Module 目录、Control 平台与分类目录、Guide 与 Reference 子目录。`docs/AI/generated/index.md` 是手工 维护的导航页，一并改名。 生成产物 `docs/AI/generated/llms/**/index-cn.md` 保持原名，它属于 LLMs Generator 的输出契约。 同步更新 28 个正式文档与 `AGENTS.md` 中的入站链接，以及两处目录树示意图。改名后全部相对链接 可解析，LLMs Generator `verify` 通过（78 控件 / 159 文件），单 Control 四件套文件名契约未变。 新增 `docs/engineering/contributing/documentation-structure-guidelines.md` 承载入口命名、文档 拆分标准、事实所有权和链接规范。此前该规则只写在带日期的设计过程记录里，不适合作为长期来源。 `docs/superpowers/specs/2026-08-10-documentation-information-architecture-design.md` 保留原文 并加取代说明，其余结论继续有效。
1.7 KiB
1.7 KiB
桌面控件文档入口
桌面控件文档按 AtomUI Gallery 的使用分类组织。每个具体控件文档应说明控件用途、核心 API、主题 Token、数据流、常见坑和源码索引。
建议分类
docs/controls/desktop/
├── general/ # Button、Icon、Typography 等
├── layout/ # Space、Grid、Flex、Splitter 等
├── navigation/ # Menu、Tabs、Breadcrumb、Pagination、Steps 等
├── data-entry/ # LineEdit、Select、TreeSelect、DatePicker、ColorPicker、Upload、Form 等
├── data-display/ # List、TreeView、DataGrid、Card、Descriptions 等
├── feedback/ # Dialog、Message、Notification、Tooltip、PopupConfirm、Spin 等
├── other/ # App、ConfigProvider、Util、BorderBeam 等
└── window/ # Window、WindowTitleBar、ImagePreviewer 等
文档边界
- 控件使用文档写在本目录。
- 控件内部实现、主题契约和维护不变量写入对应控件的
implementation.md或专项设计文档。 - DataGrid 和 ColorPicker 虽然使用独立发布包，其控件文档仍统一归到本目录，不额外维护包级模块文档。
分类入口
单控件文档建议结构
# 控件名
## 用途
## 包与命名空间
## 核心属性
## 事件与命令
## 数据流
## 主题与 Token
## 示例
## 常见问题
## 源码索引