一个项目,一个指南目录。
将已整理、可以公开的使用方法和开发说明汇入指南站。每个项目保留自己的页面与源码入口,站点统一生成索引和全文检索。
当前目录约定
projects.json # 项目信息和仓库链接
guides/
entity-identity/
content/*.md # 整理后的公开指南
assets/ # 样式、脚本、OpenAPI等静态资源
build.py # 项目指南的静态构建器
import-manifest.json # 导入来源提交及哈希
scripts/build.py # 构建整个汇总站
dist/ # 生成结果,不手工维护、不入Git
源码集合 guides/ 对应网站根目录:guides/entity-identity/ 构建到 dist/entity-identity/,公开访问 /entity-identity/。旧 /guides/entity-identity/… 地址会301跳转。新增项目使用 /<slug>/,slug不得占用 assets、guides、index、404、deployment、contributing 等站点路径。
接入下一个项目
- 整理公开文稿,保留真实实现、限制、来源和关键决策,不直接搬运私有交接记录。
- 在
projects.json添加唯一slug、名称、描述、标签、内容日期、业务仓库和指南仓库。 - 按现有指南目录约定添加项目;构建器必须输出包含
index.html和search-index.json的dist。 - 运行全站构建和检查,确认导航、下载、仓库链接及检索可用,检查生成结果没有凭据。
- 提交并推送到指南站main,等待Cloudflare Pages构建成功。
现有主体核验指南如何更新
上游指南在独立源码仓库中维护。更新并确认上游提交后,可在汇总站运行导入命令;脚本只复制约定的公开文稿、构建器和静态资源,记录来源版本,不复制Git元数据或Sites身份。
python3 scripts/import_guide.py --source <已整理的指南源码目录> --slug entity-identity
python3 scripts/build.py
python3 scripts/check.py
这是一份有明确来源的导入快照。上游业务或指南仓库的新提交不会自动传播到汇总站;需要导入并推送汇总站后才触发Pages。本版本不在Cloudflare构建时读取其他私有仓库,也不需要配置GitHub Token。
第一份指南的源码
两者均为私有仓库,需获得访问授权;阅读此公开站点不自动获得源码访问权限。