aurora-admin dd1e306c86 docs: AGENTS.md 执行约定 + 补全 ROADMAP 的结构性缺口
补三处规划漏洞(自查发现,非用户指出)

1) 缺「执行模型自动能读到的约束」
- 新建 AGENTS.md(216 行):其他模型不会主动翻 ROADMAP,但大多会自动读
  AGENTS.md。把它做成硬约束入口
- 含六条铁律(零依赖/ASCII-only/改模板/改内嵌层/data.json 是承诺/八次回归)
- 含禁止事项表(6 条)、交付说明模板、失败升级路径、关键文件地图、
  已知陷阱速查(7 条)、当前状态
- 验证过文档里承诺的命令真能跑:铁律 1 的验收命令在 package.json 不存在时
  输出 "n/a" 而非报错(原写法会失败)

2) 缺「显式不做」清单
- 新增第四章:8 项不做什么及理由(不引打包器/不做全量像素回归/不做 SSR/
  不做主题商店/不重写 app.js/不改 frameworks 视觉/不做 Storybook/不做单测)
- 没有这份清单,执行模型会以为"漏了",或在不当时机自作主张

3) 缺「未解问题」
- 新增第五章:6 个我无法单方面决策的问题(是否发布 npm/目标用户/设计团队
  协作/RTL 必要性/性能预算底线/暗色 iframe 策略),每项附影响面与建议

修正验收命令的 3 处踩坑(自查发现)
- P2 的 npm pack 校验:原写法 `npm pack | grep -q site/ && echo FAIL || echo OK`
  在 npm 不可用时 grep 也失败 → 误报 OK。改为显式判断 exit code
- P4 的 sources 文件计数:目录不存在时错误信息不友好 → 加提示与 exit 1
- 铁律 1 的依赖检查:package.json 不存在时报错 → 改为可容错

章节编号顺延(原「五、验收总纲」→「七」,因新增两章)

回归:100%(961 断言 / 0 失败 / 79 页全通过)
2026-09-11 22:47:51 +08:00

Aurora Admin Design System

理性、高效、克制的 B 端中后台设计系统:79 个组件 × 5 端实现(H5 / React / Vue 2 / Vue 3 / CSS),品牌主色 #2F54EB,全部色值取自 au-* CSS 变量令牌,零运行时依赖。

在线入口

目录结构

├─ index.html                  # Pages 入口(重定向到 site/)
├─ sitemap.xml                 # 站点地图(构建生成,部署后回填正式域名)
├─ site/                       # 文档站(纯静态,无构建依赖)
│  ├─ index.html / app.js / style.css / data.js / data.json
│  ├─ components/<slug>.html   # 每组件静态薄壳(SEO 可爬入口,构建生成)
│  ├─ scenario/user-management.html   # 场景示范页(用户管理列表页)
│  └─ llms.txt
├─ frameworks/                 # 79 组件 × 5 端实现源码(只读引用)
├─ tests/                      # 79 个组件测试页 + 回归报告 report.json
├─ tools/run-regression.mjs    # Playwright 回归 runner(CI 用)
└─ .design_library/aurora-admin/
   ├─ components/index.json    # 组件 ↔ 规格 ↔ 实现权威映射
   ├─ components/<slug>.json   # 设计契约(21 个:6 核心 + 15 输入类第一批)
   ├─ colors_and_type.css      # 设计令牌(au-* + legacy 双命名)
   └─ components.css           # 聚合组件样式

快速使用

<link rel="stylesheet" href=".design_library/aurora-admin/colors_and_type.css">
<link rel="stylesheet" href=".design_library/aurora-admin/components.css">

按端取用组件源码:frameworks/<Prefix>.{html,css,jsx,vue2.vue,vue3.vue}。

本地开发

node site/dev-server.js     # http://127.0.0.1:3311/site/
powershell -File build-site.ps1    # 重建 data.js / 薄壳 / sitemap(重建后浏览器 Ctrl+F5)
powershell -File run-tests.ps1     # 重新生成 79 个测试页
node tools/run-regression.mjs      # headless 回归(需 npm i playwright)

部署(GitHub Pages)

  1. GitHub 新建仓库(Public)。
  2. git remote add origin git@github.com:<account>/aurora-admin.git && git push -u origin main。
  3. 仓库 Settings → Pages → Source 选 GitHub Actions;推送后 .github/workflows/deploy-pages.yml 自动部署整仓。
  4. 回填正式域名:build-site.ps1 中 $SiteUrlBase 改为 https://<account>.github.io/aurora-admin/,重跑构建后推送。

设计契约与 Agent 消费

  • 组件契约(变体维度 / 使用要点 / 不发明 / 未明示):.design_library/aurora-admin/components/*.json
  • 文档站 #/agents 页汇总全部机器可读资源与使用规则
  • 生成 UI 时:色值只取令牌,变体不超出契约 dims,unknowns 项先澄清再生成

版本

见 CHANGELOG.md。当前 v1.4.1。

路线图

后续规划(可交付性、可信度、完整度、生态四阶段,含逐任务验收标准)见 ROADMAP.md。

许可证

MIT © 2026 Aurora Admin

可自由用于商业项目、修改、再分发,仅需保留版权声明。如需变更许可证(例如 Apache-2.0 或 MPL-2.0),请参考 ROADMAP.md 的 S1-P1 任务包。

S
Description
No description provided
Readme MIT
14 MiB
Languages
HTML 68.9%
JavaScript 15.2%
Vue 11.1%
CSS 4.2%
Go Template 0.3%
Other 0.3%