Skip to content

Update product docs#211

Merged
Terry-Mao merged 8 commits into
mainfrom
docs/product-docs-sync
Jun 1, 2026
Merged

Update product docs#211
Terry-Mao merged 8 commits into
mainfrom
docs/product-docs-sync

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented May 31, 2026

Synchronizes long-term product docs from merged implementation pull requests.

Latest decision:

Affected docs:

Source context:

Patch summary:
No product docs patch is needed.

Processed decisions in this PR:

  • PR Update product.md #52: Update product.md

    • docs update: required
    • reason: PR Update product.md #52 更新了已合并产品规格中的自动实现 workflow 分支契约:无 approved spec PR 时默认 implementation 分支从 oz-agent/implement-issue-<issue_number> 改为 spec/implement-issue-<issue_number>。现有长期产品文档未覆盖该 workflow 行为,因此需要补充 authoritative product docs。
    • url: Update product.md #52
    • affected docs:
    • docs/product/raw/implementation-workflow.md
  • PR Update tech.md #53: Update tech.md

    • docs update: not-needed
    • reason: PR Update tech.md #53 only corrects the technical spec's implementation branch-name examples from oz-agent/... to spec/.... The authoritative product documentation already describes the default implementation branch behavior using the spec/implement-issue_<issue_number> form, so no long-term product docs change is needed.
    • url: Update tech.md #53
    • affected docs:
    • none
  • PR feat: add issue implementation workflow #50: feat: add issue implementation workflow

    • docs update: not-needed
    • reason: PR feat: add issue implementation workflow #50 introduced the automatic implementation workflow for ready-to-implement issues, which is product-significant. The existing authoritative product doc already covers the durable behavior: trigger guards, spec-context priority, target branch selection, noop handling, draft implementation PR behavior, agent handoff files, and outer workflow responsibilities.
    • url: feat: add issue implementation workflow #50
    • affected docs:
    • docs/product/raw/implementation-workflow.md
    • change summary:
      No product docs patch is needed because docs/product/raw/implementation-workflow.md already accurately documents the merged workflow behavior.
  • PR docs(spec): create issue 51 specs #55: docs(spec): create issue 51 specs

  • PR fix(ci): tighten workflow trigger gates #56: fix(ci): tighten workflow trigger gates

    • docs update: required
    • reason: PR fix(ci): tighten workflow trigger gates #56 改变了长期 workflow 触发语义和仓库配置:spec 与 implementation workflow 的 label/assignment 事件现在需要 ready label 与目标 agent assignment 同时满足,并统一使用 AGENT_LOGIN;plan-approved spec PR label 也不再触发 implementation workflow。现有产品文档只部分覆盖 implementation workflow,且没有记录 spec workflow 的触发契约。
    • url: fix(ci): tighten workflow trigger gates #56
    • affected docs:
    • docs/product/raw/implementation-workflow.md
    • docs/product/raw/spec-workflow.md
    • change summary:
      更新 authoritative implementation workflow 文档,补充触发 gate、AGENT_LOGIN 配置和 plan-approved 语义;新增 raw 产品文档记录自动 spec workflow 的触发契约。
  • PR fix(ci): commit implementation workflow diffs #58: fix(ci): commit implementation workflow diffs

    • docs update: required
    • reason: PR fix(ci): commit implementation workflow diffs #58 changed durable workflow behavior: implementation agents now leave diffs and metadata for the outer workflow to commit and push, and spec workflow entry points are guarded from issues already marked ready-to-implement. The implementation handoff behavior was already documented, but the spec workflow gating and source attribution needed to be updated.
    • url: fix(ci): commit implementation workflow diffs #58
    • affected docs:
    • docs/product/raw/spec-workflow.md
    • docs/product/raw/implementation-workflow.md
    • change summary:
      Document that manual spec workflow dispatch still requires ready-to-spec plus target agent assignment, document that ready-to-implement suppresses spec workflow startup, and add PR fix(ci): commit implementation workflow diffs #58 to affected source references.
  • PR fix(ci): harden implementation branch handoff #59: fix(ci): harden implementation branch handoff

  • PR fix(ci): preserve implementation status paths #60: fix(ci): preserve implementation status paths

    • docs update: not-needed
    • reason: PR fix(ci): preserve implementation status paths #60 only fixes internal implementation-branch handoff plumbing so captured git porcelain status output preserves leading spaces, with a regression test. It does not change long-term product behavior, workflow triggers, user-visible semantics, configuration, or integration contracts beyond the behavior already covered by existing implementation workflow docs.
    • url: fix(ci): preserve implementation status paths #60
    • affected docs:
    • none
    • change summary:
      No product docs patch is needed.
  • PR fix(ci): dispatch reviews for generated spec PRs #65: fix(ci): dispatch reviews for generated spec PRs

    • docs update: required
    • reason: PR fix(ci): dispatch reviews for generated spec PRs #65 改变了自动 spec PR 创建后的长期工作流行为:由 create-spec workflow 显式触发 AI PR Review,并为 AI PR Review 增加按 PR number 调度的入口。现有产品文档未覆盖该触发路径和 reviewable 条件,因此需要同步权威产品文档。
    • url: fix(ci): dispatch reviews for generated spec PRs #65
    • affected docs:
    • docs/product/raw/spec-workflow.md
    • docs/product/raw/pr-review-verdict.md
    • change summary:
      更新自动 spec workflow 文档,说明生成 spec PR 后会显式触发 AI PR Review;更新 PR review 文档,说明 pull_request 与 workflow_dispatch 两种触发方式及 draft/fork PR 跳过规则。
  • PR fix(ci): harden workflow handoff file selection #67: fix(ci): harden workflow handoff file selection

    • docs update: required
    • reason: PR fix(ci): harden workflow handoff file selection #67 改变了长期 workflow 行为:implementation metadata 现在必须包含 intended_files,外层 workflow 会拒绝未声明、handoff 或生成缓存文件。该 PR 也改变了 AI PR Review 的可 review 条件与 spec PR 复用语义,因此现有产品文档需要更新。
    • url: fix(ci): harden workflow handoff file selection #67
    • affected docs:
    • docs/product/raw/implementation-workflow.md
    • docs/product/raw/pr-review-verdict.md
    • docs/product/raw/spec-workflow.md
    • change summary:
      更新 authoritative raw 产品文档,覆盖 implementation handoff 文件选择、AI PR Review 的 open/comment 触发行为,以及 spec workflow 只复用 open PR 的规则。
  • PR fix(ci): support workflow-file push token #68: fix(ci): support workflow-file push token

    • docs update: required
    • reason: PR fix(ci): support workflow-file push token #68 changes the automatic implementation workflow's long-term configuration behavior for implementation branches that modify GitHub workflow files. Product docs needed to record that such changes require WORKFLOW_UPDATE_TOKEN, while ordinary implementation pushes continue to use GITHUB_TOKEN.
    • url: fix(ci): support workflow-file push token #68
    • affected docs:
    • docs/product/raw/implementation-workflow.md
    • change summary:
      Updated the automatic implementation workflow product doc to describe WORKFLOW_UPDATE_TOKEN requirements for .github/workflows changes and added PR fix(ci): support workflow-file push token #68 to the source references.
  • PR fix(ci): use workflow token for git push auth #69: fix(ci): use workflow token for git push auth

    • docs update: not-needed
    • reason: PR fix(ci): use workflow token for git push auth #69 fixes the internal git push authentication path for workflow-file implementation branches and flushes diagnostics, without changing the documented implementation workflow contract. The existing implementation workflow docs already state that workflow-file changes require WORKFLOW_UPDATE_TOKEN and use that token for pushing.
    • url: fix(ci): use workflow token for git push auth #69
    • affected docs:
    • none
    • change summary:
      No product docs patch is needed because the change is an internal CI authentication hardening and diagnostic improvement already covered at the product-behavior level.
  • PR fix(ci): update actions for Node 24 runtime #73: fix(ci): update actions for Node 24 runtime

    • docs update: not-needed
    • reason: PR fix(ci): update actions for Node 24 runtime #73 only updates GitHub Actions runtime compatibility by upgrading action versions and opting workflow jobs into Node 24. The merged changes are CI/build plumbing and test coverage, with no change to product workflows, permissions, lifecycle rules, public contracts, or documented user-visible behavior.
    • url: fix(ci): update actions for Node 24 runtime #73
    • affected docs:
    • none
    • change summary:
      No product docs patch is needed.
  • PR fix(ci): avoid auto review for implementation PRs #74: fix(ci): avoid auto review for implementation PRs

    • docs update: required
    • reason: PR fix(ci): avoid auto review for implementation PRs #74 changes long-term workflow behavior: implementation PR creation no longer dispatches AI PR Review automatically, and PR comment mentions are routed away from issue spec/implementation workflows to review-pr. Existing product docs stated the old automatic implementation review behavior and did not clarify the PR-comment exclusion.
    • url: fix(ci): avoid auto review for implementation PRs #74
    • affected docs:
    • docs/product/raw/implementation-workflow.md
    • docs/product/raw/spec-workflow.md
    • change summary:
      Updated implementation workflow docs to state that implementation PRs remain draft and require manual PR comment mention for review, and updated spec/implementation trigger docs to clarify that PR comments are handled by the review workflow.
  • PR fix(review): skip AI review for draft PRs #76: fix(review): skip AI review for draft PRs

    • docs update: not-needed
    • reason: PR fix(review): skip AI review for draft PRs #76 changed the AI PR Review workflow so draft or fork PRs are stopped by preflight before the real review job runs. Existing product docs already state that only open, non-draft, same-repository PRs are reviewable and that draft or fork PRs are skipped without running the agent, posting review, or uploading artifacts.
    • url: fix(review): skip AI review for draft PRs #76
    • affected docs:
    • none
    • change summary:
      No product docs patch needed; the authoritative PR review behavior is already covered by existing docs/product content.
  • PR feat: add PR review verdict gate #71: feat: add PR review verdict gate

    • docs update: not-needed
    • reason: PR feat: add PR review verdict gate #71 引入的 review.json verdict 契约、non-member code PR 的 REQUEST_CHANGES 映射、CODEOWNERS reviewer 请求与保守作者判断,已由现有 docs/product/raw/pr-review-verdict.md 准确覆盖。该 PR 不需要额外长期产品文档更新。
    • url: feat: add PR review verdict gate #71
    • affected docs:
    • none
    • change summary:
      无需补丁;现有产品文档已描述本次合并后的长期产品行为。
  • PR Rename repo review companion skills #79: Rename repo review companion skills

    • docs update: required
    • reason: PR Rename repo review companion skills #79 renamed the long-lived repo review companion skills used by AI PR Review from review-pr-local/review-spec-local to review-pr-repo/review-spec-repo. Existing product docs described PR review behavior but did not record the current repo companion selection, so the authoritative docs needed a concise update.
    • url: Rename repo review companion skills #79
    • affected docs:
    • docs/product/raw/pr-review-verdict.md
    • change summary:
      Updated the PR review product doc to state that spec-only PRs use review-spec-repo, other code PRs use review-pr-repo, and both repo companions preserve the core review-pr/review-spec output contract.
  • PR 新增一个 review-pr-local / review-spec-local #81: 新增一个 review-pr-local / review-spec-local

    • docs update: required
    • reason: PR 新增一个 review-pr-local / review-spec-local #81 新增 review-pr-local 与 review-spec-local,提供本地运行仓库 PR/spec review workflow 的用户入口,改变了长期 review 工作流行为。现有产品文档只覆盖 GitHub AI PR Review 的触发、skill 选择和 verdict 语义,未记录本地 review 的输入输出快照、spec context 行为和 mutation guard 约束。
    • url: 新增一个 review-pr-local / review-spec-local #81
    • affected docs:
    • docs/product/raw/pr-review-verdict.md
    • change summary:
      已在 docs/product/raw/pr-review-verdict.md 增加本地 review 入口章节,说明 review-pr-local/review-spec-local 的适用时机、委托关系、根目录快照契约、干净 worktree 要求、只允许 review 输出变更的校验约束,以及 base/spec context 解析行为。
  • PR fix(ci): stop auto-reviewing spec PRs #84: fix(ci): stop auto-reviewing spec PRs

    • docs update: required
    • reason: PR fix(ci): stop auto-reviewing spec PRs #84 changes the long-term spec workflow behavior by stopping automatic AI PR Review dispatch after spec PR creation or update. Existing product docs still described the old automatic dispatch behavior, so the authoritative spec workflow documentation was updated.
    • url: fix(ci): stop auto-reviewing spec PRs #84
    • affected docs:
    • docs/product/raw/spec-workflow.md
    • change summary:
      Updated the Spec PR follow-up review section to state that spec PRs are no longer auto-reviewed and must be reviewed via PR comment mention when needed.
  • PR feat: sync issue state on plan approval #66: feat: sync issue state on plan approval

    • docs update: required
    • reason: PR feat: sync issue state on plan approval #66 adds durable lifecycle behavior for spec plan approval: plan-approved now removes ready-to-spec from the linked issue and may dispatch implementation when ready-to-implement and the target agent assignment are already present. Existing product docs mentioned plan-approved as implementation context, but did not document the new issue state synchronization or conditional dispatch behavior.
    • url: feat: sync issue state on plan approval #66
    • affected docs:
    • docs/product/raw/spec-workflow.md
    • docs/product/raw/implementation-workflow.md
    • change summary:
      Updated raw product docs to describe spec plan approval semantics, automatic ready-to-spec removal, explicit ready-to-implement ownership, and conditional implementation dispatch after approval.
  • PR feat: add PR bot review command trigger #82: feat: add PR bot review command trigger

    • docs update: required
    • reason: PR feat: add PR bot review command trigger #82 changes the long-term AI PR Review trigger contract from a bare PR comment mention to an exact body-level @AGENT_LOGIN /review command, with non-draft/open PR gating and invalid comment forms skipped. Existing product docs still described bare @AGENT_LOGIN PR comment triggering, so authoritative docs needed correction.
    • url: feat: add PR bot review command trigger #82
    • affected docs:
    • docs/product/raw/pr-review-verdict.md
    • docs/product/raw/implementation-workflow.md
    • docs/product/raw/spec-workflow.md
    • change summary:
      Updated raw product docs to document @AGENT_LOGIN /review as the PR conversation comment command for manually requesting AI review, including body-level command constraints and skipped invalid forms.
  • PR fix(review): link comment-triggered runs to PRs #89: fix(review): link comment-triggered runs to PRs

    • docs update: required
    • reason: PR fix(review): link comment-triggered runs to PRs #89 changes long-term AI PR Review behavior: comment-triggered and manual runs for same-repo PRs now publish an AI PR Review commit status on the PR head. Existing product docs described those triggers but did not document the PR association/status semantics.
    • url: fix(review): link comment-triggered runs to PRs #89
    • affected docs:
    • docs/product/raw/pr-review-verdict.md
    • change summary:
      Updated the authoritative PR review raw product doc with the commit status lifecycle, target URL association, and scope limits for comment/manual AI PR Review runs.
  • PR docs(spec): create issue 85 specs #86: docs(spec): create issue 85 specs

    • docs update: not-needed
    • reason: PR docs(spec): create issue 85 specs #86 mainly merged specs for future local review dirty-worktree behavior, and those specs explicitly state they do not implement the behavior. The implemented AI PR Review status behavior included in the merge is already covered by docs/product/raw/pr-review-verdict.md, so no long-term product docs change is needed.
    • url: docs(spec): create issue 85 specs #86
    • affected docs:
    • none
    • change summary:
      No docs/product patch needed; existing product docs already describe the delivered PR comment/manual AI PR Review commit status behavior, and the issue 85 dirty-worktree behavior remains spec-only in this PR.
  • PR feat: allow local review with dirty worktrees #90: feat: allow local review with dirty worktrees

    • docs update: required
    • reason: PR feat: allow local review with dirty worktrees #90 changed the long-term behavior of local PR/spec review entrypoints: they now support dirty worktrees, generate review diffs from the current worktree snapshot, and use a baseline status file for validation. Existing product docs still stated that local review required a clean worktree, so the authoritative docs needed correction.
    • url: feat: allow local review with dirty worktrees #90
    • affected docs:
    • docs/product/raw/pr-review-verdict.md
    • change summary:
      Updated the local review entrypoint documentation to describe dirty-worktree support, current-worktree diff semantics, the .local_review_baseline.status file, validation boundaries, and the PR/spec sources.
  • PR feat(skill): add security review supplements #93: feat(skill): add security review supplements

    • docs update: required
    • reason: PR feat(skill): add security review supplements #93 changes the long-term AI PR Review workflow by adding security-review-pr and security-review-spec as mandatory supplemental passes for code and spec reviews. Existing product docs described review skill selection and review.json semantics but did not cover security supplement scope, reporting, or verdict impact.
    • url: feat(skill): add security review supplements #93
    • affected docs:
    • docs/product/raw/pr-review-verdict.md
    • change summary:
      Updated the authoritative PR review product doc to describe security supplemental review behavior, covered concern areas, reporting boundaries, [SECURITY] labeling, and verdict impact.
  • PR feat(skill): add git worktree helper #94: feat(skill): add git worktree helper

    • docs update: required
    • reason: PR feat(skill): add git worktree helper #94 新增了面向用户/agent 的 git-worktree helper skill,并确立了默认 .worktrees 目录、分支命名复用、安全检查、fetch 行为和已存在资源处理语义。这些是长期本地开发工作流知识,现有 docs/product 内容没有覆盖。
    • url: feat(skill): add git worktree helper #94
    • affected docs:
    • docs/product/raw/local-git-helper-skills.md
    • change summary:
      新增 docs/product/raw/local-git-helper-skills.md,记录 git-worktree 的默认目录、分支命名、base 选择、fetch 行为、dirty worktree 语义、已存在 branch/worktree/path 的停止规则,以及不会自动提交、推送或删除的安全边界。
  • PR docs(agents): add repository agent guidance #97: docs(agents): add repository agent guidance

    • docs update: not-needed
    • reason: PR docs(agents): add repository agent guidance #97 只新增仓库级 .agents/AGENTS.md,用于约束 AI coding agent 在本仓库内的操作、校验和安全边界。该变更没有改变 AICodingFlow 的长期产品概念、用户流程、workflow 行为、配置语义或公开契约,因此不需要更新 docs/product/
    • url: docs(agents): add repository agent guidance #97
    • affected docs:
    • none
    • change summary:
      无需产品文档补丁;保留现有 docs/product/ 内容不变。
  • PR fix(review): prefer GitHub PR description locally #103: fix(review): prefer GitHub PR description locally

    • docs update: required
    • reason: PR fix(review): prefer GitHub PR description locally #103 changed the local review input contract: pr_description.txt now prefers metadata from the GitHub PR associated with the current branch and falls back to locally generated metadata only when that fetch is unavailable. This is durable user-facing workflow behavior already covered by the local review product doc, so the authoritative docs need a targeted update.
    • url: fix(review): prefer GitHub PR description locally #103
    • affected docs:
    • docs/product/raw/pr-review-verdict.md
    • change summary:
      Updated the local review entrypoint documentation to state the pr_description.txt source priority and clarify that pr_diff.txt remains generated from the local worktree diff.
  • PR docs(skill): enter new worktree by default #105: docs(skill): enter new worktree by default

    • docs update: required
    • reason: PR docs(skill): enter new worktree by default #105 改变了 git-worktree helper skill 的长期用户可见行为:成功创建后后续 agent 工作默认进入新 worktree,并新增 pwd 确认与 --no-track 创建语义。现有 raw 产品文档已覆盖该 skill,但仍描述旧行为,因此需要同步更新。
    • url: docs(skill): enter new worktree by default #105
    • affected docs:
    • docs/product/raw/local-git-helper-skills.md
    • change summary:
      更新 docs/product/raw/local-git-helper-skills.mdgit-worktree 成功创建后的行为说明,记录 --no-track、新 worktree 目录中的 pwd 确认、报告字段以及后续命令默认从新 worktree 运行。
  • PR docs(skill): prefer origin for branch bases #107: docs(skill): prefer origin for branch bases

    • docs update: required
    • reason: PR docs(skill): prefer origin for branch bases #107 changed the long-term behavior of local Git helper skills: same-repository branch and worktree creation now prefer origin/, remote-base branch creation avoids tracking the base, and git-worktree clarifies that Codex tool-call directories do not move the user's existing shell. Existing product docs still described upstream/main as the default worktree base order, so the authoritative raw doc needed updating.
    • url: docs(skill): prefer origin for branch bases #107
    • affected docs:
    • docs/product/raw/local-git-helper-skills.md
    • change summary:
      Updated the local Git helper skills raw product doc to document git-branch behavior, origin-first base selection for same-repository work, no-track remote-base creation, git-worktree remote-base handling, and the distinction between Codex tool-call working directories and the user's shell.
  • PR docs(skill): optimize git skill workflows #109: docs(skill): optimize git skill workflows

    • docs update: required
    • reason: PR docs(skill): optimize git skill workflows #109 changes durable behavior for local Git helper skills, including worktree path semantics and when GitHub, remote, fetch, and freshness checks are performed. Existing product docs still described the old flattened worktree slug path and did not cover the updated git-commit/git-push behavior.
    • url: docs(skill): optimize git skill workflows #109
    • affected docs:
    • docs/product/raw/local-git-helper-skills.md
    • change summary:
      Updated the authoritative local Git helper skills doc for combined local checks, conditional remote/freshness checks, preserved .worktrees/ directory structure, and the git-commit/git-push helper behavior introduced by PR docs(skill): optimize git skill workflows #109.
  • PR docs(skill): remove cloud workflow guidance #110: docs(skill): remove cloud workflow guidance

    • docs update: not-needed
    • reason: PR docs(skill): remove cloud workflow guidance #110 only removes obsolete cloud-specific wording from internal skill instructions and keeps the same long-term workflow contract: agents prepare local changes and outer workflows handle publishing. Existing product docs already describe the generic implementation workflow behavior without cloud-specific semantics.
    • url: docs(skill): remove cloud workflow guidance #110
    • affected docs:
    • none
    • change summary:
      No product docs patch is needed because the current docs/product content already reflects the merged generic workflow behavior.
  • PR fix: delay PR comment push credentials #99: fix: delay PR comment push credentials

    • docs update: required
    • reason: PR fix: delay PR comment push credentials #99 introduced the merged respond-to-pr-comment workflow, which changes long-term PR collaboration behavior, trigger semantics, branch strategy, authorization rules, and handoff contracts. Existing product docs did not contain authoritative coverage for this /fix workflow and had outdated PR comment routing language.
    • url: fix: delay PR comment push credentials #99
    • affected docs:
    • docs/product/raw/pr-comment-response-workflow.md
    • docs/product/raw/implementation-workflow.md
    • docs/product/raw/spec-workflow.md
    • change summary:
      Added a raw product doc for the PR comment response workflow and updated spec/implementation workflow docs to distinguish /review PR comments from /fix PR comments.
  • PR docs(skill): add CI failure diagnosis skill #112: docs(skill): add CI failure diagnosis skill

    • docs update: required
    • reason: PR docs(skill): add CI failure diagnosis skill #112 added the diagnose-ci-failures skill, which introduces a durable agent-facing workflow for CI failure diagnosis, supported inputs, output expectations, and diagnosis-only boundaries. Existing product docs did not cover this CI diagnosis capability.
    • url: docs(skill): add CI failure diagnosis skill #112
    • affected docs:
    • docs/product/raw/ci-failure-diagnosis-skill.md
    • change summary:
      Added a new authoritative raw product doc describing the CI failure diagnosis skill, including target discovery, log analysis scope, error categorization, plan output, and no-code-change boundary.
  • PR 新增 resolve-merge-conflicts #114: 新增 resolve-merge-conflicts

    • docs update: required
    • reason: PR 新增 resolve-merge-conflicts #114 merged a new user-facing agent skill, resolve-merge-conflicts, with durable workflow behavior, supported conflict types, CLI output modes, and safety boundaries. Existing product docs did not cover this merge-conflict resolution capability.
    • url: 新增 resolve-merge-conflicts #114
    • affected docs:
    • docs/product/raw/merge-conflict-resolution-skill.md
    • change summary:
      Added a raw product doc describing when to use the resolve-merge-conflicts skill, what conflict context it exposes, supported output modes, and the local-only resolution and validation boundaries.
  • PR fix: align local review base selection with PR metadata #116: fix: align local review base selection with PR metadata

    • docs update: required
    • reason: PR fix: align local review base selection with PR metadata #116 changed the long-term behavior of local review input preparation: existing PR branches now use the PR base SHA unless an explicit base is provided, explicit base metadata stays synchronized with the diff base, and fallback base selection now prefers origin/main before upstream/main. Existing product docs described the older base ordering and needed correction.
    • url: fix: align local review base selection with PR metadata #116
    • affected docs:
    • docs/product/raw/pr-review-verdict.md
    • change summary:
      Updated the authoritative local review documentation to describe PR base SHA precedence, explicit base synchronization, and the new origin/main fallback order.
  • PR fix: correct CODEOWNERS enforcement note #118: fix: correct CODEOWNERS enforcement note

    • docs update: required
    • reason: PR fix: correct CODEOWNERS enforcement note #118 新增 bootstrap-issue-config skill,并引入 issue triage label config 与 CODEOWNERS ownership hints 的长期产品行为。现有 product docs 未覆盖该初始化流程或 CODEOWNERS branch-protection 语义,因此需要新增权威 raw 文档。
    • url: fix: correct CODEOWNERS enforcement note #118
    • affected docs:
    • docs/product/raw/bootstrap-issue-config-skill.md
    • change summary:
      新增 docs/product/raw/bootstrap-issue-config-skill.md,记录 bootstrap issue triage 初始化 skill 的用途、产出文件、label config 结构、CODEOWNERS owner 推断与 branch protection 语义,以及幂等初始化边界。
  • PR fix: preserve PR title for comment responses #120: fix: preserve PR title for comment responses

    • docs update: required
    • reason: PR fix: preserve PR title for comment responses #120 changes durable behavior of the PR comment response workflow: direct push-head responses no longer rewrite the original PR title or body, and response comments now include a summary derived from pr_summary. Existing product docs described the old push-head PR metadata update behavior, so they needed correction.
    • url: fix: preserve PR title for comment responses #120
    • affected docs:
    • docs/product/raw/pr-comment-response-workflow.md
    • change summary:
      Updated the authoritative PR comment response workflow doc to state that push-head runs preserve the original PR title/body, still use pr_title and pr_summary for validation and metadata, and include a cleaned summary in the response comment when present.
  • PR feat(triage): add issue triage workflow #121: feat(triage): add issue triage workflow

    • docs update: required
    • reason: PR feat(triage): add issue triage workflow #121 adds a new issue triage workflow with durable user-visible trigger behavior, structured triage output semantics, label/comment application rules, and duplicate/follow-up handling. Existing product docs only describe bootstrap triage configuration, so the runtime workflow needed an authoritative long-term product doc.
    • url: feat(triage): add issue triage workflow #121
    • affected docs:
    • docs/product/raw/issue-triage-workflow.md
    • change summary:
      Added docs/product/raw/issue-triage-workflow.md covering issue triage triggers, context preparation, triage_result.json contract, label rules, duplicate/follow-up semantics, and GitHub update boundaries.
  • PR fix(triage): prefetch dedupe candidates #123: fix(triage): prefetch dedupe candidates

    • docs update: required
    • reason: PR fix(triage): prefetch dedupe candidates #123 changes the long-term issue triage contract: duplicate checking now uses workflow-prefetched candidates instead of agent-side GitHub issue scans. Existing product docs described the triage context and duplicate output but did not capture this authoritative candidate source, recent-closed window, or empty-candidate behavior.
    • url: fix(triage): prefetch dedupe candidates #123
    • affected docs:
    • docs/product/raw/issue-triage-workflow.md
    • change summary:
      Updated the issue triage workflow docs to describe dedupe_candidates.json as the authoritative duplicate-check input, the open plus recent-closed candidate window, pull request exclusion, empty-candidate handling, and the duplicate_of source semantics.
  • PR docs(skills): remove repo name from descriptions #126: docs(skills): remove repo name from descriptions

    • docs update: not-needed
    • reason: PR docs(skills): remove repo name from descriptions #126 only removes a hard-coded repository name from repo-local skill description metadata. The merged diff does not change long-term product behavior, workflows, permissions, lifecycle rules, configuration semantics, public errors, or integration contracts.
    • url: docs(skills): remove repo name from descriptions #126
    • affected docs:
    • none
    • change summary:
      No product docs patch is needed; the change is a narrow wording cleanup in .agents skill descriptions.
  • PR ci(review): clarify review output path #127: ci(review): clarify review output path

    • docs update: not-needed
    • reason: PR ci(review): clarify review output path #127 only clarifies the AI review workflow prompt so file-editing tools target pr-worktree/review.json directly. It does not change long-term product behavior, review eligibility, review output schema, verdict semantics, or GitHub review publishing behavior; existing product docs already cover the durable review.json contract.
    • url: ci(review): clarify review output path #127
    • affected docs:
    • none
    • change summary:
      No product docs patch is needed.
  • PR 新增 SKILL: update-dedupe,用于自进化 dedupe-issue #128: 新增 SKILL: update-dedupe,用于自进化 dedupe-issue

    • docs update: required
    • reason: PR 新增 SKILL: update-dedupe,用于自进化 dedupe-issue #128 adds the long-lived repo-specific dedupe companion skill, which changes the product knowledge available to issue triage and duplicate detection. Existing product docs only referenced this companion indirectly, so a narrow authoritative raw doc was added for its scope, empty initial cluster state, and update boundary.
    • url: 新增 SKILL: update-dedupe,用于自进化 dedupe-issue #128
    • affected docs:
    • docs/product/raw/dedupe-guidance-companion.md
    • change summary:
      Added docs/product/raw/dedupe-guidance-companion.md documenting the dedupe-issue-repo companion, its limits relative to core dedupe-issue behavior, the empty initial Known-duplicate clusters state, and the future update boundary.
  • PR fix: apply agents implementation output #130: fix: apply agents implementation output

    • docs update: required
    • reason: PR fix: apply agents implementation output #130 改变了自动实现 workflow 的长期 agent/runner 交接合同:当 .agents 目录在 Codex sandbox 中不可写时,agent 可以通过 implementation-output/.agents/... 输出 replacement 文件,并由外层 workflow 校验后应用。现有产品文档只描述了 intended_files 和提交校验,未覆盖这个持久行为。
    • url: fix: apply agents implementation output #130
    • affected docs:
    • docs/product/raw/implementation-workflow.md
    • change summary:
      更新自动实现 workflow 文档,说明 .agents 文件的 implementation-output 交接路径、intended_files 校验要求、仅允许 .agents/ 前缀以及 implementation-output 不作为提交候选。
  • PR feat: add update-dedupe guidance workflow #129: feat: add update-dedupe guidance workflow

    • docs update: required
    • reason: PR feat: add update-dedupe guidance workflow #129 introduced the long-lived update-dedupe skill and manual workflow, including trigger semantics, evidence requirements, write-surface boundaries, and PR behavior. Existing product docs covered the dedupe companion but did not document this workflow itself.
    • url: feat: add update-dedupe guidance workflow #129
    • affected docs:
    • docs/product/raw/update-dedupe-workflow.md
    • change summary:
      Added a new raw product doc describing the update-dedupe workflow, strong duplicate evidence requirements, repeated-cluster learning behavior, allowed write surface, and PR behavior.
  • PR fix(update-dedupe): repair feedback aggregation query #131: fix(update-dedupe): repair feedback aggregation query

    • docs update: not-needed
    • reason: PR fix(update-dedupe): repair feedback aggregation query #131 fixes internal update-dedupe feedback aggregation plumbing by avoiding a GitHub GraphQL variable collision, expanding query placeholders correctly, and printing gh stderr on failure. It does not change the documented product workflow, duplicate evidence rules, write boundaries, or user-facing behavior already covered by the update-dedupe product docs.
    • url: fix(update-dedupe): repair feedback aggregation query #131
    • affected docs:
    • none
    • change summary:
      No product docs patch is needed because the change is an internal script reliability fix and existing long-term docs already describe the stable workflow semantics.
  • PR test(update-dedupe): cover feedback aggregation safety #132: test(update-dedupe): cover feedback aggregation safety

    • docs update: not-needed
    • reason: PR test(update-dedupe): cover feedback aggregation safety #132 keeps the existing update-dedupe product behavior: when guidance changes exist, the workflow creates or updates a PR whose body includes the evidence summary. The implementation moved body construction into a helper and uses gh --body-file to treat generated summary text as data, but this is internal workflow hardening already consistent with the documented behavior.
    • url: test(update-dedupe): cover feedback aggregation safety #132
    • affected docs:
    • none
    • change summary:
      No product docs patch needed because the long-term user-visible workflow contract did not change.
  • PR docs(triage): add repo triage guidance #133: docs(triage): add repo triage guidance

    • docs update: required
    • reason: PR docs(triage): add repo triage guidance #133 changes durable workflow behavior by adding repository-specific triage guidance and tightening PR/implementation agent context handling around stable local snapshots. Existing product docs covered the workflows generally but did not describe the new companion skill rules, PR comment snapshot inputs, or no-fetch boundary.
    • url: docs(triage): add repo triage guidance #133
    • affected docs:
    • docs/product/raw/issue-triage-workflow.md
    • docs/product/raw/pr-comment-response-workflow.md
    • docs/product/raw/implementation-workflow.md
    • change summary:
      Updated authoritative raw product docs for issue triage, PR comment response, and implementation workflows to capture PR docs(triage): add repo triage guidance #133's companion triage rules and stable local context boundaries.
  • PR fix(triage): allow external issue triage #138: fix(triage): allow external issue triage

    • docs update: required
    • reason: PR fix(triage): allow external issue triage #138 改变了 issue triage workflow 的长期触发规则:普通 issue 作者的 needs-info follow-up 可重新触发分诊,同时 bot、PR mirror issue events 和 edited comments 被排除。现有产品文档仍描述旧的 maintainer-only comment trigger,因此需要同步。
    • url: fix(triage): allow external issue triage #138
    • affected docs:
    • docs/product/raw/issue-triage-workflow.md
    • change summary:
      更新 issue triage workflow 的触发条件,记录非 bot issue opened/reopened、needs-info issue 作者 follow-up、bot/automation 与非 created 评论事件排除规则,并补充来源引用。
  • PR ci(workflows): use GitHub App token for workflow updates #139: ci(workflows): use GitHub App token for workflow updates

    • docs update: required
    • reason: PR ci(workflows): use GitHub App token for workflow updates #139 改变了修改 .github/workflows/* 时 implementation 与 PR comment response 提交所使用的长期凭据模型。现有 raw product docs 仍描述静态 WORKFLOW_UPDATE_TOKEN secret,或缺少 PR comment response 的对应行为,因此需要更新权威产品文档。
    • url: ci(workflows): use GitHub App token for workflow updates #139
    • affected docs:
    • docs/product/raw/implementation-workflow.md
    • docs/product/raw/pr-comment-response-workflow.md
    • change summary:
      更新 raw product docs,说明 workflow 根据 intended_files 条件性通过 actions/create-github-app-token 生成 GitHub App installation token,并记录所需的 WORKFLOW_UPDATE_APP_CLIENT_ID variable、WORKFLOW_UPDATE_APP_PRIVATE_KEY secret、GitHub App 权限,以及不修改 workflow 文件时继续使用默认写入凭据。
  • PR fix(workflows): authenticate PR diff fetch #140: fix(workflows): authenticate PR diff fetch

    • docs update: not-needed
    • reason: PR fix(workflows): authenticate PR diff fetch #140 only changes the internal GitHub Actions implementation used by AI PR Review and PR comment response workflows to fetch PR base commits with a one-shot authenticated Git extraheader. The merged behavior does not change product workflow triggers, agent context contracts, branch strategies, permissions exposed to users, or public error semantics already documented under docs/product/.
    • url: fix(workflows): authenticate PR diff fetch #140
    • affected docs:
    • none
    • change summary:
      No product docs patch is needed.

This PR may accumulate multiple product docs sync decisions until it is reviewed and merged.

@github-actions github-actions Bot requested a review from Terry-Mao as a code owner May 31, 2026 16:47
@Terry-Mao Terry-Mao merged commit 5b78c87 into main Jun 1, 2026
2 checks passed
@Terry-Mao Terry-Mao deleted the docs/product-docs-sync branch June 1, 2026 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant