跳至主要内容

更新紀錄規則

摘要

所有涉及 web-docs/ 的變更,都必須同步更新 web-docs/docs/updates/index.md。這讓文件中心本身的變更、template demo 調整、UI 修改和營運文件更新都有清楚紀錄。

執行方式

  • 小型變更:在 updates index 新增一行摘要,說明變更內容和原因。
  • 大型變更:新增 YYYY-MM-DD-short-slug.md 詳情頁,並在 updates index 連結。
  • 每次提交前,檢查是否有 web-docs/ 變更;如有,確認更新紀錄已同步。

原因

web-docs 是 eagleagentic.ai 的 canonical documentation hub。更新紀錄能幫助團隊追蹤文件、範本和營運規則如何演進,避免重要變更只留在 git diff 或 commit message 中。