From 1f01c61cde693712b1598772fcc4834fdbb480c2 Mon Sep 17 00:00:00 2001
From: guocheng <guocheng@ustc.edu.cn>
Date: Wed, 29 Jul 2026 20:12:37 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E9=83=A8=E7=BD=B2=E4=BE=9D?=
 =?UTF-8?q?=E8=B5=96?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .gitea/workflows/deploy.yml      | 16 ++++++++++++++--
 CLAUDE.md                        | 12 +++++++++---
 README.md                        |  4 ++--
 doc_builder/build.py => build.py |  4 ++--
 4 files changed, 27 insertions(+), 9 deletions(-)
 rename doc_builder/build.py => build.py (99%)

diff --git a/.gitea/workflows/deploy.yml b/.gitea/workflows/deploy.yml
index 3806505..ed942f8 100644
--- a/.gitea/workflows/deploy.yml
+++ b/.gitea/workflows/deploy.yml
@@ -13,9 +13,21 @@ jobs:
   build-and-deploy:
     runs-on: ubuntu-act-latest
 
+    defaults:
+      run:
+        working-directory: readout_program
+
     steps:
-      - name: Checkout
+      - name: Checkout readout_program
         uses: https://gitee.com/actions-mirror/checkout@v4
+        with:
+          path: readout_program
+
+      - name: Checkout rbpu_datasheet
+        uses: https://gitee.com/actions-mirror/checkout@v4
+        with:
+          repository: ${{ github.repository_owner }}/rbpu_datasheet
+          path: rbpu_datasheet
 
       - name: Configure pip mirror
         run: pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple
@@ -24,7 +36,7 @@ jobs:
         run: pip install --retries 3 -r requirements.txt
 
       - name: Build documentation
-        run: python doc_builder/build.py
+        run: python build.py
 
       - name: Deploy to Caddy
         env:
diff --git a/CLAUDE.md b/CLAUDE.md
index 4c73dee..d6d655a 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -10,11 +10,11 @@ Markdown 纯文本写作 + Git 版本控制 + Python 构建管道 → 自包含
 ### 目录结构
 ```
 project.yaml          # 项目元数据与章节列表
+build.py              # 构建入口（项目根目录）
 chapters/             # Markdown 章节源文件（唯一编辑目标）
 assets/               # 图片资源
 data/                 # 结构化数据源（CSV/YAML/JSON，通过 @import 引用）
 doc_builder/          # Python 构建工具
-  build.py            # 构建入口
   templates/          # HTML 模板
   themes/             # CSS 样式
   renderers/          # 自定义渲染器（@import / 代码块渲染）
@@ -40,6 +40,12 @@ output/               # 构建产物（gitignore）
 - **禁止绝对路径**（尤其是 Windows 盘符路径如 `D:/code/...`）
 - 构建时自动内嵌为 base64，生成自包含 HTML
 
+### README 规范
+- README.md 必须包含 **CI/CD 状态徽章**（指向 Gitea Actions workflow 的 badge URL）
+- README.md 必须包含 **在线文档/部署链接**，指向文档的实际访问地址
+- 徽章格式: `[![Build Status](<gitea_server>/<org>/<repo>/actions/workflows/<workflow>.yml/badge.svg)](<gitea_server>/<org>/<repo>/actions)`
+- 部署链接格式: `📖 **在线文档**: [<url>](<url>)`
+
 ### 交叉引用
 - 内部引用: `详见 [标题锚点](#标题锚点)`
 - 外部引用: `[文档名](path/to/doc.md)`
@@ -58,7 +64,7 @@ output/               # 构建产物（gitignore）
 pip install -r requirements.txt
 
 # 构建 HTML
-python doc_builder/build.py
+python build.py
 
 # 输出: output/<标题>.html
 ```
@@ -91,7 +97,7 @@ python doc_builder/build.py
 
 | 修改内容 | 编辑目标 | 构建方式 |
 |:---|:---|:---|
-| 正文内容 | `chapters/*.md` | `python doc_builder/build.py` |
+| 正文内容 | `chapters/*.md` | `python build.py` |
 | 章节顺序 | `project.yaml` → `chapters:` 列表 | 同上 |
 | 图片 | `assets/` | 同上（自动内嵌） |
 | 结构化数据 | `data/*.csv` / `data/*.yaml` / `data/*.json` | 同上（通过 @import 注入） |
diff --git a/README.md b/README.md
index 4d10c67..7a76b3e 100644
--- a/README.md
+++ b/README.md
@@ -18,11 +18,11 @@
 
 ```
 project.yaml          # 项目配置（标题、作者、版本、章节列表）
+build.py              # 构建入口（项目根目录）
 chapters/             # Markdown 章节源文件
 assets/               # 图片资源
 data/                 # 结构化数据源（CSV/YAML/JSON，通过 @import 引用）
 doc_builder/          # Python 构建工具
-  build.py            # 构建入口
   templates/          # HTML 模板（含 A4 封面）
   themes/             # CSS 样式（屏幕 + 打印）
   renderers/          # 自定义渲染器（@import / 代码块）
@@ -40,7 +40,7 @@ output/               # 构建产物（.gitignore）
 pip install -r requirements.txt
 
 # 2. 构建
-python doc_builder/build.py
+python build.py
 
 # 3. 打开 output/<标题>.html 即可浏览
 ```
diff --git a/doc_builder/build.py b/build.py
similarity index 99%
rename from doc_builder/build.py
rename to build.py
index d8b133f..4f47dcb 100644
--- a/doc_builder/build.py
+++ b/build.py
@@ -6,7 +6,7 @@ Docs as Code — 构建入口
 → 组装 → 注入锚点 → 提取目录 → 模板渲染 → 自包含 HTML 报告。
 
 用法:
-    python doc_builder/build.py
+    python build.py
 
 输出:
     output/<标题>.html  （自包含 HTML，可离线分发）
@@ -27,7 +27,7 @@ import yaml
 from jinja2 import Environment, FileSystemLoader, select_autoescape
 
 # ---------- 路径配置 ----------
-PROJECT_ROOT = Path(__file__).resolve().parent.parent
+PROJECT_ROOT = Path(__file__).resolve().parent
 CHAPTERS_DIR = PROJECT_ROOT / "chapters"
 ASSETS_DIR = PROJECT_ROOT / "assets"
 OUTPUT_DIR = PROJECT_ROOT / "output"