瀏覽代碼

chore: consolidate docs into doc, add doc/README conventions (Web 2.4.77 / API 1.0.44)

Made-with: Cursor
skygu 3 月之前
父節點
當前提交
379511be62

+ 2 - 0
AGENTS.md

@@ -10,3 +10,5 @@
 - **发版必升号**;**每次 Git 提交只要包含实质文件变动,须在同一提交中同时递增前端与后端版本号**(`Web/package.json` 的 `version` patch +1;`server/Admin.NET.Web.Entry/Admin.NET.Web.Entry.csproj` 的 `<Version>` / `<AssemblyVersion>` / `<FileVersion>` 同步 patch +1)。详见 **[`.cursor/rules/version-bump-on-commit.mdc`](.cursor/rules/version-bump-on-commit.mdc)**。
 - **发版必升号**;**每次 Git 提交只要包含实质文件变动,须在同一提交中同时递增前端与后端版本号**(`Web/package.json` 的 `version` patch +1;`server/Admin.NET.Web.Entry/Admin.NET.Web.Entry.csproj` 的 `<Version>` / `<AssemblyVersion>` / `<FileVersion>` 同步 patch +1)。详见 **[`.cursor/rules/version-bump-on-commit.mdc`](.cursor/rules/version-bump-on-commit.mdc)**。
 
 
 说明与索引:[`.cursor/rules/README.md`](.cursor/rules/README.md)
 说明与索引:[`.cursor/rules/README.md`](.cursor/rules/README.md)
+
+**主库文档目录**:新增与维护说明类 Markdown、方案、附件请放在 **[`doc/`](doc/README.md)**(见 `doc/README.md` 中的目录约定);**不要**在仓库根目录再使用并列的 `docs/`。

+ 1 - 1
Web/package.json

@@ -1,7 +1,7 @@
 {
 {
 	"name": "admin.net",
 	"name": "admin.net",
 	"type": "module",
 	"type": "module",
-  "version": "2.4.76",
+	"version": "2.4.77",
 	"packageManager": "pnpm@10.32.1",
 	"packageManager": "pnpm@10.32.1",
 	"lastBuildTime": "2026.03.15",
 	"lastBuildTime": "2026.03.15",
 	"description": "Admin.NET 站在巨人肩膀上的 .NET 通用权限开发框架",
 	"description": "Admin.NET 站在巨人肩膀上的 .NET 通用权限开发框架",

+ 57 - 0
doc/README.md

@@ -0,0 +1,57 @@
+# 文档目录说明(`doc/`)
+
+本仓库**主文档根目录为 `doc/`**。请勿在仓库根目录再新建并列的 `docs/` 存放本仓库文档(历史 `docs/` 已并入此处)。
+
+---
+
+## 与子目录 `ai-dop-platform/docs/` 的区别
+
+| 路径 | 归属 | 用途 |
+|------|------|------|
+| **`doc/`**(本文件所在) | Ai-DOP **主库**(含 `Web/`、`server/`) | 主库业务方案、审批流说明、会议记录、数据库导出脚本等 |
+| **`ai-dop-platform/docs/`** | **子目录** `ai-dop-platform` | 平台侧架构、上手、SQL、SmartOps 数据模型等,**不随本次合并迁移** |
+
+在 Cursor 中引用平台文档时,仍使用 `@ai-dop-platform/docs/...`。
+
+---
+
+## 目录约定
+
+| 子目录 / 位置 | 放置内容 |
+|----------------|----------|
+| **`doc/plan/`** | 各模块/专题的**实施方案、设计说明**(如 `plan/S1/`) |
+| **`doc/meeting/`** | 会议纪要、评审记录、过程性附件 |
+| **`doc/db/`** | 与主库相关的**表结构导出、生成脚本**(如 Excel、Python) |
+| **`doc/` 根下** | 跨模块的**功能说明、集成指南**等独立 Markdown(命名建议见下) |
+| **`doc/img/`**、`doc/shop/` 等 | 文档用**图片、截图**等资源(保持现有结构即可) |
+
+---
+
+## 命名与格式
+
+1. **语言**:面向团队的说明以**中文**为主;需对外或开源时再提供英文版可复制路径。
+2. **文件名**:使用可读中文或 `模块-主题.md`,避免无意义缩写;审批流相关已约定:
+   - `审批流功能说明.md` — 用户/产品视角功能清单
+   - `审批流集成开发指南.md` — 开发接入步骤与 API
+3. **新增文档**:优先放入上表对应子目录;若无合适子目录,放在 `doc/` 根并在本 README「文档索引」中补一行(或后续集中整理到子目录)。
+4. **大附件**:二进制、Excel、SQL 体积较大时,可放在 `doc/db/` 或专题子目录,**不要**把生成物硬编码为机器绝对路径;脚本输出宜相对脚本目录(参见 `doc/db/gen_table_excel.py`)。
+
+---
+
+## 文档索引(维护中)
+
+| 文档 | 说明 |
+|------|------|
+| [审批流功能说明.md](./审批流功能说明.md) | 审批流菜单、审批中心、设计器、通知与权限 |
+| [审批流集成开发指南.md](./审批流集成开发指南.md) | `IFlowBizHandler`、`ApprovalPanel`、配置与 API |
+| [plan/S1/S1-订单管理-审批流程实施方案.md](./plan/S1/S1-订单管理-审批流程实施方案.md) | S1 订单审批实施方案 |
+| [指标模型动态配置方案.md](./指标模型动态配置方案.md) | 指标模型动态配置总体方案 |
+| [meeting/20260408/vue-tsc-既存类型错误说明.md](./meeting/20260408/vue-tsc-既存类型错误说明.md) | 前端类型问题说明 |
+
+**指标模型(SmartOps)主设计**仍在:`ai-dop-platform/docs/db/smart_ops_data_model/README.txt`。
+
+---
+
+## 变更记录
+
+- **2026-04-16**:根目录 `docs/` 已合并至 `doc/`(含 `doc/db/` 与根下方案文档),并增加本规范文件。

+ 0 - 0
docs/db/aidopdev_表结构汇总.xlsx → doc/db/aidopdev_表结构汇总.xlsx


+ 2 - 1
docs/db/gen_table_excel.py → doc/db/gen_table_excel.py

@@ -2,6 +2,7 @@
 """从 aidopdev 数据库导出全部表结构到 Excel,按业务分类分 Sheet。"""
 """从 aidopdev 数据库导出全部表结构到 Excel,按业务分类分 Sheet。"""
 
 
 import pymysql
 import pymysql
+from pathlib import Path
 from openpyxl import Workbook
 from openpyxl import Workbook
 from openpyxl.styles import Font, PatternFill, Alignment, Border, Side
 from openpyxl.styles import Font, PatternFill, Alignment, Border, Side
 from collections import OrderedDict
 from collections import OrderedDict
@@ -163,7 +164,7 @@ def main():
         ws = wb.create_sheet(title=safe_title)
         ws = wb.create_sheet(title=safe_title)
         write_detail_sheet(ws, cat, tnames, tables, columns)
         write_detail_sheet(ws, cat, tnames, tables, columns)
 
 
-    out = "/root/aidopdemo/docs/db/aidopdev_表结构汇总.xlsx"
+    out = Path(__file__).resolve().parent / "aidopdev_表结构汇总.xlsx"
     wb.save(out)
     wb.save(out)
     print(f"Done → {out}")
     print(f"Done → {out}")
 
 

+ 0 - 0
docs/指标模型动态配置方案.md → doc/指标模型动态配置方案.md


+ 3 - 3
server/Admin.NET.Web.Entry/Admin.NET.Web.Entry.csproj

@@ -11,9 +11,9 @@
     <GenerateSatelliteAssembliesForCore>true</GenerateSatelliteAssembliesForCore>
     <GenerateSatelliteAssembliesForCore>true</GenerateSatelliteAssembliesForCore>
     <Copyright>Admin.NET</Copyright>
     <Copyright>Admin.NET</Copyright>
     <Description>Admin.NET 通用权限开发平台</Description>
     <Description>Admin.NET 通用权限开发平台</Description>
-    <AssemblyVersion>1.0.43</AssemblyVersion>
-    <FileVersion>1.0.43</FileVersion>
-    <Version>1.0.43</Version>
+    <AssemblyVersion>1.0.44</AssemblyVersion>
+    <FileVersion>1.0.44</FileVersion>
+    <Version>1.0.44</Version>
   </PropertyGroup>
   </PropertyGroup>
 
 
   <ItemGroup>
   <ItemGroup>