用途:保持公开的 GitHub Pages 站点(site-docs/)与源代码和内部文档同步,避免站点内容滞后于实现。
触发条件:修改 synapse/.py、synapse/commands/.py 等核心模块,synapse/profiles/.yaml,plugins/**/,pyproject.toml(版本、依赖、入口点),guides/.md、docs/.md、README.md,或直接编辑 site-docs/** 时自动触发。也可手动执行 /github-pages-sync 运行完整的 site-docs 同步检查。
工作流程分四阶段。一,检测变更:借助 references/source-site-mapping.md 找出受影响的 site-docs 页面,例如 CLI 命令对应 reference/cli.md,API 端点对应 reference/api.md,Profile 设置对应 concepts/profiles.md 与 reference/profiles-yaml.md,环境变量对应 reference/configuration.md,新功能对应 index.md 及相关指南,版本更新对应 changelog.md 与 index.md 徽章。二,提出更新:读取当前页面内容,定位需修改的具体章节,只提出最小必要改动并交由用户批准。三,应用更新:获批后修改 site-docs/ 页面,新增页面时同步更新 mkdocs.yml 导航,面向用户的变更需更新 changelog.md。四,验证:运行 uv run mkdocs build --strict,检查构建是否成功、内部交叉引用链接是否损坏、mkdocs.yml 导航与实际文件是否一致。
更新原则:保持 MkDocs Material 格式(admonitions、tabs、代码注解);只改受影响章节,不整页重写;index.md 保持简洁,细节放入 guide/ 或 reference/;未发生架构变化时保留原有 Mermaid 图;确保 mkdocs.yml 导航结构一致。
特殊场景:版本更新需写发行说明并检查徽章;新功能需加入 index.md 亮点、创建或更新对应页面、更新 CLI/API 参考并调整导航;新增 CLI 命令需在 reference/cli.md 写完整语法与示例;弃用功能需加 deprecated 提示、必要时提供迁移指南并更新 changelog.md。详细页面清单与源到页面映射见 references/source-site-mapping.md 与 references/site-inventory.md。
限制:默认需用户批准后才应用改动;具体运行环境、依赖前提与更多配置细节资料中暂未提供。