贡献与本地维护
发现解释不清或事实过期时,请指出章节、小节、疑问和依据。对机制的修正优先提供固定版本的官方文档、源码或可复现记录。
本地预览
安装 Node.js 22.12 或更新版本,在仓库根目录执行:
npm ci
npm run docs:dev提交前执行 npm test、npm run docs:build。远程来源可运行 npm run check:links 检查;网络失败需要区分不可达和页面已失效。图片、布局或搜索变化还需浏览器检查。
本地选中批注
完成依赖安装后,运行 npm run review,打开返回的本机网址。选中文字后点“批注选中文字”,填写意见并保存;图注旁也可以点“批注此图”。右下角“批注”面板可定位原文、编辑意见、查看已处理记录及导出。
批注只保存在本地,不上传公共阅读站。保存失败会明确提示,并保留浏览器草稿供重试;原文变化后无法唯一定位的意见,不会自动跳到相似句子。
标完后,在当前 Codex 对话说“按批注修改手册”,或用面板的“复制给 Codex”生成指令。Codex 会冻结本轮意见、备份原稿,再逐条修改 Markdown 和必要配图,验证后记录处理结果。期间新加的意见保留到后续处理,原批注和历史不会清空。
node scripts/review.mjs status 查询当前地址,stop 停止后台,build 在改稿后更新本地阅读页。后台只负责保存与审阅,不需要模型密钥。
在 Codex 中跟上官方最新
在 Codex 打开本仓库,输入:
跟上官方最新,更新手册。或显式使用 $hello-hermes-sync。技能位于 .agents/skills/hello-hermes-sync/SKILL.md,支持仓库技能的 Codex 可以自动发现它。界面暂未显示时,可直接让 Codex 读取这个文件;无需复制一份到全局目录。
流程先运行 npm run sync:check 收集只读报告,再核对差异、修改受影响章节和图片,完成验证后创建或更新 codex/sync-upstream 的维护 PR。GitHub 读写使用已登录的连接或 gh;不需要另配置内容生成 API。
报告脚本需要 Git 和已登录的 GitHub CLI(gh);图解更新需要当前 Codex 环境提供 imagegen。缺少这些能力时,技能应说明具体缺口,保留已完成的草稿与证据,不能宣称维护已全部完成。
报告会标明脏工作区、现有 PR、比较是否完整、未发布变化及错误。工具不会自行宣布章节已核对,也不会自动合并 PR。图片工具不可用时保留待补图项,不将这次修订报告为完整完成。
内容与图解的约定
写作前读仓库中的 editorial/writing.md,配图前读 editorial/visuals.md。每章回答一个问题,保留例子、推理和代价;新版正文不放源码跳转,核对来源与版本保存在内部审核记录。图文一起审核,避免改了机制却留下旧箭头。
新版章节由 content/chapters.json 的 path 决定,旧十四章与旧批注继续绑定原路径。不要按相同编号覆盖旧文,也不要把旧核对日期直接继承到新版。
正文及原创图解采用 CC BY-SA 4.0,站点代码、维护脚本和 skill 采用 MIT。第三方资料保持原链接与归属。