Просмотр исходного кода

chore: reorganize project structure and centralize documentation into docs/

- Centralize documentation: moved review reports into docs/reviews/ and workflow.md into docs/.
- Documentation hub: added docs/README.md indexing all architectural and design docs.
- Clean workspace: fortified .gitignore with .DS_Store and Python caches, removed untracked artifacts.
- Synchronized references: updated file maps and navigation in CLAUDE.md and README.md.
Dew-OF-Aurora 3 недель назад
Родитель
Сommit
8f0443da2c

+ 13 - 1
.gitignore

@@ -5,4 +5,16 @@ local_runtime/
 cfst*/
 busybox*/
 vmess/
-vmess.tar.gz
+vmess.tar.gz
+
+# OS and Editor files
+.DS_Store
+._*
+*.swp
+*.swo
+
+# Python bytecode and caches
+__pycache__/
+*.py[cod]
+*$py.class
+.pytest_cache/

+ 13 - 4
CLAUDE.md

@@ -31,6 +31,14 @@ scripts/
 ├── install_debian.sh          # systemd timer/service 安装
 └── uninstall_debian.sh        # systemd 卸载
 
+docs/
+├── README.md                  # 文档导航中心
+├── workflow.md                # 业务全景工作流图 (Mermaid)
+└── reviews/                   # 架构审查、分歧裁决与修复台账归档
+    ├── ARCHITECTURE_REVIEW_UNIFIED.md  # 终审统一报告与演进台账(唯一权威)
+    ├── ARCHITECTURE_REVIEW.md          # 历史初审报告归档
+    └── ARCHITECTURE_REVIEW_RECHECK.md  # 历史复核报告归档
+
 substore/
 └── operator_template.js       # Sub-Store 脚本操作符,消费运行时 JSON
 
@@ -125,12 +133,13 @@ sudo bash scripts/uninstall_debian.sh
 
 ## Where to Look
 
-- 想了解架构终审与缺陷复现清单 → `ARCHITECTURE_REVIEW_UNIFIED.md`
+- 想了解架构终审与缺陷复现清单 → `docs/reviews/ARCHITECTURE_REVIEW_UNIFIED.md`
 - 想了解自动化测试用例 → `tests/`
 - 想了解配置字段含义 → 直接读对应的 config JSON/conf 文件,字段名即文档
-- 想了解评分/筛选逻辑 → `scripts/domain_updater.py`
+- 想了解评分/筛选逻辑 → `scripts/domain_updater.py` / `scripts/rotator/`
 - 想了解 git 提交/推送流程 → `scripts/run_update_and_commit.sh`
 - 想了解 systemd 部署细节 → `scripts/install_debian.sh`
 - 想了解下游消费方式 → `substore/operator_template.js`
-- 想了解完整工作流图 → `workflow.md`(Mermaid 流程图)
-- 想了解用户文档 → `README.md`
+- 想了解完整工作流图 → `docs/workflow.md`(Mermaid 流程图)
+- 想了解项目综合文档中心 → `docs/README.md`
+- 想了解用户快速上手文档 → `README.md`

+ 6 - 0
README.md

@@ -25,6 +25,12 @@
 - `config.local.json`:本地 Python `cfst` 模式
 - `config_router.conf`:BusyBox 路由器模式
 
+文档中心:
+
+- `docs/README.md`:项目文档中心导航
+- `docs/workflow.md`:业务全景工作流图 (Mermaid)
+- `docs/reviews/`:架构终审报告、历史复核与修复台账
+
 > 旧 `config.json` / `config.example.json` 已废弃。
 
 ---

+ 22 - 0
docs/README.md

@@ -0,0 +1,22 @@
+# 项目文档中心 (Documentation Hub)
+
+本目录归档 `vmess-domain-rotator` 的业务设计、流程图解及架构审查历史记录。
+
+---
+
+## 目录索引
+
+### 1. 业务流程与系统架构
+- 📐 [**业务全景工作流图 (workflow.md)**](./workflow.md):包含 Server 定时更新、Git 孤儿分支发布、BusyBox 路由器轻量轮换及 Sub-Store 消费端的 Mermaid 完整业务时序与架构图。
+
+### 2. 架构审查与演进台账 (Reviews & Architecture)
+- 🏆 [**架构终审统一报告与修复台账 (ARCHITECTURE_REVIEW_UNIFIED.md)**](./reviews/ARCHITECTURE_REVIEW_UNIFIED.md)
+  > **唯一权威来源**:三方交叉复核、分歧终审裁决、27 项问题台账、全套自动化测试套件建设及方案 B(模式 A 滚动修剪、SSOT 联动、rotator 模块化)落地报告。
+- 📦 [**初审报告归档 (ARCHITECTURE_REVIEW.md)**](./reviews/ARCHITECTURE_REVIEW.md)
+- 📦 [**复核报告归档 (ARCHITECTURE_REVIEW_RECHECK.md)**](./reviews/ARCHITECTURE_REVIEW_RECHECK.md)
+
+---
+
+## 根目录核心规范
+- 📖 [**项目快速上手指南 (README.md)**](../README.md):针对终端操作者的使用与配置指南。
+- 🤖 [**Agent 唯一权威指引 (CLAUDE.md)**](../CLAUDE.md):针对开发与维护智能体的工作准则、命令与文件地图。

+ 0 - 0
ARCHITECTURE_REVIEW.md → docs/reviews/ARCHITECTURE_REVIEW.md


+ 0 - 0
ARCHITECTURE_REVIEW_RECHECK.md → docs/reviews/ARCHITECTURE_REVIEW_RECHECK.md


+ 0 - 0
ARCHITECTURE_REVIEW_UNIFIED.md → docs/reviews/ARCHITECTURE_REVIEW_UNIFIED.md


+ 0 - 0
workflow.md → docs/workflow.md