Skip to content

Update product docs#260

Merged
Terry-Mao merged 4 commits into
mainfrom
docs/product-docs-sync
Jun 10, 2026
Merged

Update product docs#260
Terry-Mao merged 4 commits into
mainfrom
docs/product-docs-sync

Conversation

@github-actions

@github-actions github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

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

Latest decision:

Affected docs:

  • docs/product/raw/update-triage-workflow.md

Source context:

Patch summary:
新增 docs/product/raw/update-triage-workflow.md,记录 update-triage 的触发输入、维护者修正信号学习规则、允许写入范围和固定 PR 行为。

Processed decisions in this PR:

  • Omitted 94 older processed decisions to keep the PR body within GitHub limits.

  • PR Compile product wiki #213: Compile product wiki

    • docs update: not-needed
    • reason: PR Compile product wiki #213 仅重新编译 docs/product/raw/docs/product/wiki/,变更范围是派生 wiki 页面和编译日志。现有产品文档已声明 docs/product/raw/ 是权威来源,且本次没有 raw 文档、spec、产品代码或 workflow 行为变更。
    • url: Compile product wiki #213
    • affected docs:
    • none
    • change summary:
      无需产品文档补丁;不修改 docs/product/
  • PR fix: 跳过 product docs sync 中缺失的 issue 引用 #215: fix: 跳过 product docs sync 中缺失的 issue 引用

    • docs update: required
    • reason: PR fix: 跳过 product docs sync 中缺失的 issue 引用 #215 改变了 Product Docs Sync 的长期 workflow 行为:单个 linked issue 读取失败时不再中断上下文准备,而是跳过该 issue 并继续处理 merged PR。现有产品文档只描述了 issue 引用进入上下文和 specs 读取流程,未覆盖缺失或不可读取 issue 的过滤规则。
    • url: fix: 跳过 product docs sync 中缺失的 issue 引用 #215
    • affected docs:
    • docs/product/raw/product-docs-sync-workflow.md
    • change summary:
      更新 Product Docs Sync workflow 权威文档,说明 unreadable linked issue 会被跳过,linked_issues 和相关 specs 只包含成功读取的 issue,且该情况不会让可处理的 merged PR 变为 should_run=false。
  • PR fix: append product docs sync PR comments #217: fix: append product docs sync PR comments

    • docs update: required
    • reason: PR fix: append product docs sync PR comments #217 changed the long-term Product Docs Sync workflow behavior: every create or update of the docs sync PR now appends a per-run PR comment with the current decision details. Existing product docs described the fixed-branch PR body and ledger behavior but did not cover the new conversation comment record.
    • url: fix: append product docs sync PR comments #217
    • affected docs:
    • docs/product/raw/product-docs-sync-workflow.md
    • change summary:
      Updated the Product Docs Sync workflow raw product doc to describe appended per-run PR comments on the docs sync PR, including fields, uncertain confirmation visibility, and the rule that old bot comments are not edited.
  • PR Compile product wiki #222: Compile product wiki

    • docs update: not-needed
    • reason: PR Compile product wiki #222 only compiled the generated docs/product/wiki knowledge layer from existing docs/product/raw sources. It did not introduce new product behavior, and the authoritative raw product docs already include the relevant source documents.
    • url: Compile product wiki #222
    • affected docs:
    • none
    • change summary:
      No docs/product changes are needed.
  • PR Compile product wiki #226: Compile product wiki

    • docs update: not-needed
    • reason: PR Compile product wiki #226 只是将现有 docs/product/raw/ 内容重新编译为 docs/product/wiki/ 知识层,没有引入新的权威产品行为、workflow、配置语义或公开契约。变更属于派生 wiki 内容同步,长期产品事实仍已由现有 raw 文档覆盖。
    • url: Compile product wiki #226
    • affected docs:
    • none
    • change summary:
      无需修改 docs/product/;本次只记录 not-needed 决策。
  • PR fix(review): suppress repeated bot review comments #227: fix(review): suppress repeated bot review comments

    • docs update: required
    • reason: PR fix(review): suppress repeated bot review comments #227 changes long-term AI PR Review behavior by adding prior review discussion snapshots and duplicate suppression for resolved, maintainer-dismissed, and still-unresolved bot inline comments. Existing product docs covered review workflow behavior but did not document this discussion context or its instruction-safety boundary.
    • url: fix(review): suppress repeated bot review comments #227
    • affected docs:
    • docs/product/raw/pr-review-verdict.md
    • change summary:
      Updated docs/product/raw/pr-review-verdict.md to document review_discussion_context.json generation, duplicate-suppression rules, maintainer dismissal handling, unresolved-thread handling, and REVIEW_BOT_LOGIN source attribution.
  • PR 修复 review dismiss 误判和换行输出 #228: 修复 review dismiss 误判和换行输出

    • docs update: required
    • reason: PR 修复 review dismiss 误判和换行输出 #228 改变了 AI PR Review 的长期用户可见行为:维护者 dismissal 识别不再把否定或疑问语境中的 intentional 裸词当作已 dismiss,并且发布 review 前会把 fenced code block 外的字面量 \n 规范化为真实换行。现有产品文档只概括了 dismissed/resolved 去重和 review 输出契约,未覆盖这些精确语义。
    • url: 修复 review dismiss 误判和换行输出 #228
    • affected docs:
    • docs/product/raw/pr-review-verdict.md
    • change summary:
      更新 docs/product/raw/pr-review-verdict.md,补充 maintainer dismissal 的肯定语义要求、否定或疑问 intentional 回复的处理方式,以及 GitHub review 发布前对 markdown body/comment 中字面量 \n 的换行规范化规则。
  • PR fix(review): 使用 GitHub PR diff 快照 #231: fix(review): 使用 GitHub PR diff 快照

    • docs update: required
    • reason: PR fix(review): 使用 GitHub PR diff 快照 #231 changed the authoritative PR diff snapshot behavior for GitHub-hosted review and /fix workflows from a local base/head git diff to the GitHub PR diff API with before-and-after SHA validation. This is long-term workflow and public failure-semantics knowledge that was not explicitly covered by the existing product docs.
    • url: fix(review): 使用 GitHub PR diff 快照 #231
    • affected docs:
    • docs/product/raw/pr-review-verdict.md
    • docs/product/raw/pr-comment-response-workflow.md
    • change summary:
      Document that GitHub workflow PR diff snapshots for AI PR Review and /fix now come from the GitHub PR diff API, and that the workflows fail if the PR head or base SHA changes while preparing the diff.
  • PR Compile product wiki #234: Compile product wiki

    • docs update: not-needed
    • reason: PR Compile product wiki #234 only compiled existing authoritative docs/product/raw/ content into docs/product/wiki/. It did not change implementation behavior, specs, raw product docs, or any long-term product rule that is not already represented by the existing product documentation.
    • url: Compile product wiki #234
    • affected docs:
    • none
    • change summary:
      No product docs patch is needed because the merged PR updated only the generated wiki query layer from existing raw sources.
  • PR Compile product wiki #238: Compile product wiki

    • docs update: not-needed
    • reason: PR Compile product wiki #238 only updates compiled Product LLM Wiki pages under docs/product/wiki/ from existing docs/product/raw/ sources. The authoritative long-term product facts are already covered by raw docs, so no additional product docs patch is warranted.
    • url: Compile product wiki #238
    • affected docs:
    • none
    • change summary:
      No docs/product changes needed; the merged PR is a compiled wiki refresh from existing authoritative raw product docs.
  • PR Compile product wiki #242: Compile product wiki

    • docs update: not-needed
    • reason: PR Compile product wiki #242 仅编译并刷新 docs/product/wiki/ 查询层,变更文件全部位于 compiled wiki。它没有修改实现、spec 或 docs/product/raw/ 权威来源,也没有引入新的长期产品行为或规则。
    • url: Compile product wiki #242
    • affected docs:
    • none
    • change summary:
      无需文档补丁;现有 raw product docs 仍是权威来源,本次合并只是基于这些来源更新派生 wiki。
  • PR refactor(workflows): extract shared script helpers #245: refactor(workflows): extract shared script helpers

    • docs update: not-needed
    • reason: PR refactor(workflows): extract shared script helpers #245 is a workflow script refactor that extracts shared helper modules and moves existing context, GitHub API, ledger, metadata, and artifact I/O logic behind reusable Python helpers. The merged diff does not introduce a new product workflow, lifecycle, permission model, configuration contract, or user-visible behavior that is not already covered by the existing product docs sync workflow documentation.
    • url: refactor(workflows): extract shared script helpers #245
    • affected docs:
    • none
    • change summary:
      No product docs patch is needed because the change is internal workflow script structure and regression coverage only.
  • PR refactor(review): extract shared review contracts #246: refactor(review): extract shared review contracts

    • docs update: required
    • reason: PR refactor(review): extract shared review contracts #246 changed long-term AI PR Review behavior by introducing a shared review contract and moving local review snapshots/output to system temporary-directory paths. Existing authoritative raw product docs still described repo-root local snapshots and did not document .agents/contracts/ as a shared workflow/skill contract area.
    • url: refactor(review): extract shared review contracts #246
    • affected docs:
    • docs/product/raw/agent-directory-layout.md
    • docs/product/raw/pr-review-verdict.md
    • change summary:
      Updated authoritative raw product docs to describe .agents/contracts/, shared review contract/schema ownership, core review entrypoints with repo companion guidance, and temporary-directory local review snapshot/output paths.
  • PR Compile product wiki #248: Compile product wiki

    • docs update: not-needed
    • reason: PR Compile product wiki #248 only updated the generated Product LLM Wiki compile log under docs/product/wiki/log.md. It did not change authoritative raw product knowledge, specs, workflows, permissions, lifecycle rules, APIs, configuration semantics, or user-visible product behavior.
    • url: Compile product wiki #248
    • affected docs:
    • none
    • change summary:
      No product docs patch is needed; the change is a generated wiki compile log entry and belongs outside authoritative long-term product docs.
  • PR refactor(workflows): move handoff files to temp dir #247: refactor(workflows): move handoff files to temp dir

    • docs update: not-needed
    • reason: PR refactor(workflows): move handoff files to temp dir #247 改变了 spec、implementation 和 PR comment response workflow 的 handoff 路径与提交排除契约,但该 PR 已同步更新对应的长期产品文档。现有 docs/product/raw/implementation-workflow.md、docs/product/raw/pr-comment-response-workflow.md 和 docs/product/raw/spec-workflow.md 已覆盖合并后的 .codex-runtime/handoff 行为、metadata 边界和 spec handoff 限制。
    • url: refactor(workflows): move handoff files to temp dir #247
    • affected docs:
    • none
    • change summary:
      无需补丁;合并 PR 已包含并落地所需的 docs/product/raw 更新。
  • PR fix: validate product report spec links #249: fix: validate product report spec links

    • docs update: required
    • reason: PR fix: validate product report spec links #249 改变了 product change report 的长期来源引用契约和状态校验行为:spec 引用必须使用从 docs/updates/ 出发的仓库相对 Markdown 链接,并且错误 spec source reference 会被拒绝。现有产品文档只记录了 commit ID 和 related issue URL 校验,未覆盖该已合并行为。
    • url: fix: validate product report spec links #249
    • affected docs:
    • docs/product/raw/product-change-reports.md
    • change summary:
      更新 docs/product/raw/product-change-reports.md 的来源引用和校验行为章节,补充 spec source reference 的合法链接格式、非法目标类型和状态校验拒绝规则。
  • PR Update PR review guidance #250: Update PR review guidance

    • docs update: required
    • reason: PR Update PR review guidance #250 merged durable repo-local AI PR Review guidance that changes how reviews interpret intra-PR path changes, product wiki/raw source support, and issue-number reference validation. Existing product docs described the companion guidance mechanism but did not capture these current review behavior rules.
    • url: Update PR review guidance #250
    • affected docs:
    • docs/product/raw/pr-review-verdict.md
    • change summary:
      Updated the authoritative PR review product doc with the newly merged repo-local review guidance and added PR Update PR review guidance #250 to the source references.
  • PR refactor(install): skip upstream tests by default #253: refactor(install): skip upstream tests by default

    • docs update: not-needed
    • reason: PR refactor(install): skip upstream tests by default #253 changed the project installer sync boundary by excluding .github/aicodingflow-tests/ from default target-repository installs. The merged PR already updated the authoritative product documentation to describe the current default sync scope and the upstream-test-directory boundary.
    • url: refactor(install): skip upstream tests by default #253
    • affected docs:
    • docs/product/raw/project-installer.md
    • change summary:
      No additional product docs patch is needed because docs/product/raw/project-installer.md already records that .github/aicodingflow-tests/ is an upstream-managed test directory and is not installed by default.
  • PR Compile product wiki #255: Compile product wiki

    • docs update: not-needed
    • reason: PR Compile product wiki #255 only recompiles derived files under docs/product/wiki/ from existing docs/product/raw/ sources. It does not introduce or change authoritative product behavior, workflow contracts, configuration semantics, or public user-facing rules that require a raw product docs update.
    • url: Compile product wiki #255
    • affected docs:
    • none
    • change summary:
      No product docs patch is needed; the PR updates generated wiki summaries and concepts from existing authoritative raw sources.
  • PR feat: 新增 update-triage 自进化流程 #254: feat: 新增 update-triage 自进化流程

    • docs update: required
    • reason: PR feat: 新增 update-triage 自进化流程 #254 新增了可由维护者手动触发的 update-triage 自进化 workflow,并定义了 triage 反馈学习规则、写入边界和 PR 行为。这是长期产品行为变更,现有产品文档只覆盖 issue triage、update-dedupe 和 update-pr-review,未覆盖该新流程。
    • url: feat: 新增 update-triage 自进化流程 #254
    • affected docs:
    • docs/product/raw/update-triage-workflow.md
    • change summary:
      新增 docs/product/raw/update-triage-workflow.md,记录 update-triage 的触发输入、维护者修正信号学习规则、允许写入范围和固定 PR 行为。

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 June 9, 2026 18:39
@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor Author

Product Docs Sync processed a source PR.

Affected docs:

  • docs/product/raw/pr-review-verdict.md

Patch summary:
Updated the authoritative PR review product doc with the newly merged repo-local review guidance and added PR #250 to the source references.

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor Author

Product Docs Sync processed a source PR.

Affected docs:

  • docs/product/raw/project-installer.md

Patch summary:
No additional product docs patch is needed because docs/product/raw/project-installer.md already records that .github/aicodingflow-tests/ is an upstream-managed test directory and is not installed by default.

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor Author

Product Docs Sync processed a source PR.

  • source PR: Compile product wiki #255
  • docs update: not-needed
  • reason: PR Compile product wiki #255 only recompiles derived files under docs/product/wiki/ from existing docs/product/raw/ sources. It does not introduce or change authoritative product behavior, workflow contracts, configuration semantics, or public user-facing rules that require a raw product docs update.
  • source URL: Compile product wiki #255

Affected docs:

  • none

Patch summary:
No product docs patch is needed; the PR updates generated wiki summaries and concepts from existing authoritative raw sources.

@github-actions

Copy link
Copy Markdown
Contributor Author

Product Docs Sync processed a source PR.

Affected docs:

  • docs/product/raw/update-triage-workflow.md

Patch summary:
新增 docs/product/raw/update-triage-workflow.md,记录 update-triage 的触发输入、维护者修正信号学习规则、允许写入范围和固定 PR 行为。

@Terry-Mao
Terry-Mao merged commit 88b36b6 into main Jun 10, 2026
1 check passed
@Terry-Mao
Terry-Mao deleted the docs/product-docs-sync branch June 10, 2026 03:42
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