研发笔记 — 架构决策 + 设计要点 版本: v1.0 | 创建: coslog-002
改了某样东西之后,需要同步改哪些?备忘于此。
| 改了… | 需要… |
|---|---|
任何 .md / .html / .pdf 文档 |
不需编译,顶多重打包 zip(仅 PDF 参与打包) |
config.py 路径常量 |
重编译 Clarity |
bootstrap_tab.py 标签4 UI 文字 (DEFAULT_BIO) |
重编译 Clarity |
CSF打包协议.md YAML 配置 |
不需编译,重启 Clarity 生效 |
bootstrap_tab.py 内置默认 YAML (_BUILTIN_CONFIG) |
重编译 Clarity |
csf-lite-doc/csf发行.jpg(不改文件名和位置) |
不需编译,重启 Clarity 生效 |
安装与配置.html(根目录):独立对外网页,README 链接它。仅影响 GitHub Pages 展示,不参与编译/打包/Clarity 运行。
安装与配置.pdf(根目录):被 CSF打包协议.md → copy_files 引用,打包 zip 时复制进包。改了需要重新打包 zip(点标签4按钮),旧 zip 不含新版 PDF。
csf-lite-doc/安装与配置.md:PDF 的 Markdown 源文件(推测)。12 个文档交叉引用它,0 处代码引用。改了需同步更新 PDF 版本。
csf-lite-doc/Clarity-使用手册.md:纯人类文档。0 处被代码引用,0 处被打包引用。改了不影响任何编译/打包产物。
csf-lite-doc/csf发行.jpg:被 bootstrap_tab.py L566 硬编码引用(标签4 知识星球二维码图)。运行时从磁盘读取,不是编译时嵌入。换图不需重编译,重启 Clarity 生效。
CSF打包协议.md(csf-lite/protocols/):被 bootstrap_tab.py 运行时读取 YAML 配置块。改了不需重编译,重启 Clarity 生效。但若文件丢失则用 _BUILTIN_CONFIG 兜底——改兜底值需重编译。
bootstrap_tab.py 标签4 _BUILTIN_CONFIG:内置打包默认值(zip 命名模板、清洁规则、copy_files 等)。改了需重编译。
bootstrap_tab.py 标签4 DEFAULT_BIO:社区/授权/联系方式的 HTML 硬编码。改了需重编译。
config.py:CSF_LITE_ROOT、CSF_CLARITY_DIR、STAGING_DIR 等路径常量。所有模块通过 import 引用。改了需重编译。
生效: coslog-002
csf/ ← 项目根目录
├── csf-lite/ ← CSF 框架(纯 MD 文件,不含 exe)
├── clarity/ ← Clarity 桌面程序
│ ├── clarity.exe ← 主程序(双击启动)
│ └── csf-clarity/ ← 运行时数据(AI 不可访问)
├── clarity-dev/ ← Clarity 源码
├── csf-lite-doc/ ← 使用文档(安装说明、使用手册)
└── ...(essays, cases, csf-minimal 等对外内容)
关键约束:
clarity.exe 放在 clarity/ 内csf-clarity/ 与 clarity.exe 同目录(即 clarity/csf-clarity/)csf-lite/ 与 clarity/ 平级,均在项目根目录下clarity-dev/src/config.py