Skip to content

Commit e217050

Browse files
committed
Update architecture documentation to clarify notebook cleanup and PDF renaming workflows
1 parent 6639060 commit e217050

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

architecture-zh.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Notebook 打包由 `.github/workflows/package-notebooks.yml` 处理。
6767

6868
该工作流会在以下情况下运行:
6969

70-
- 推送到 `main` 且变更涉及 `zh/**``en/**`、Jupyter profile、Notebook 转换辅助脚本或该工作流本身
70+
- 推送到 `main` 且变更涉及 `zh/**``en/**`、Jupyter profile、Notebook 清理辅助脚本或该工作流本身
7171
- GitHub Releases;
7272
- 手动触发。
7373

@@ -102,14 +102,14 @@ dispatch payload 包含源仓库、工作流运行 ID、artifact 名称、归档
102102

103103
Typst PDF 编译由 `.github/workflows/render-pdf.yml` 处理。
104104

105-
当推送到 `main` 且变更涉及源章节、Typst profiles、参考文献文件、Typst header 文件、Mermaid 渲染辅助脚本或该工作流本身时,该工作流会运行。它也会在 GitHub Releases 和手动触发时运行。
105+
当推送到 `main` 且变更涉及源章节、Typst profiles、参考文献文件、Typst header 文件、PDF 重命名辅助脚本或该工作流本身时,该工作流会运行。它也会在 GitHub Releases 和手动触发时运行。
106106

107107
PDF 生成使用以下 Quarto profiles:
108108

109109
- `_quarto-typst-en.yml`
110110
- `_quarto-typst-zh.yml`
111111

112-
该工作流为中文和英文 PDF 分别设置 job。每个 job 会检出仓库,安装对应语言需要的字体,设置 Quarto,安装 Node.js 和 Mermaid CLI,将 Puppeteer 配置为使用 GitHub runner 上的 Chrome,然后渲染对应 profile:
112+
该工作流为中文和英文 PDF 分别设置 job。每个 job 会检出仓库,安装对应语言需要的字体,设置 Quarto,然后渲染对应 profile:
113113

114114
```bash
115115
quarto render --profile typst-zh

architecture.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Notebook packaging is handled by `.github/workflows/package-notebooks.yml`.
6767

6868
This workflow runs on:
6969

70-
- Pushes to `main` that touch `zh/**`, `en/**`, the Jupyter profile, the notebook conversion helpers, or the workflow itself;
70+
- Pushes to `main` that touch `zh/**`, `en/**`, the Jupyter profile, the notebook cleanup helper, or the workflow itself;
7171
- GitHub Releases;
7272
- Manual dispatch.
7373

@@ -102,14 +102,14 @@ The dispatch payload includes the source repository, workflow run ID, artifact n
102102

103103
Typst PDF compilation is handled by `.github/workflows/render-pdf.yml`.
104104

105-
The workflow runs on pushes to `main` that touch the source chapters, Typst profiles, bibliography files, Typst header files, Mermaid rendering helpers, or the workflow itself. It also runs on GitHub Releases and manual dispatch.
105+
The workflow runs on pushes to `main` that touch the source chapters, Typst profiles, bibliography files, Typst header files, the PDF rename helper, or the workflow itself. It also runs on GitHub Releases and manual dispatch.
106106

107107
PDF generation uses these Quarto profiles:
108108

109109
- `_quarto-typst-en.yml`
110110
- `_quarto-typst-zh.yml`
111111

112-
The workflow has separate jobs for Chinese and English PDFs. Each job checks out the repository, installs the fonts needed by that language, sets up Quarto, installs Node.js and Mermaid CLI, configures Puppeteer to use the GitHub runner Chrome binary, and then renders the matching profile:
112+
The workflow has separate jobs for Chinese and English PDFs. Each job checks out the repository, installs the fonts needed by that language, sets up Quarto, and then renders the matching profile:
113113

114114
```bash
115115
quarto render --profile typst-zh

0 commit comments

Comments
 (0)