Skip to content

docs(adapters): fix stale Codex and Cursor smoke commands in host matrix - #10

Open
creayma-del wants to merge 4 commits into
QoderAI:mainfrom
creayma-del:fix/adapter-docs-stale-commands
Open

docs(adapters): fix stale Codex and Cursor smoke commands in host matrix#10
creayma-del wants to merge 4 commits into
QoderAI:mainfrom
creayma-del:fix/adapter-docs-stale-commands

Conversation

@creayma-del

@creayma-del creayma-del commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

The Host Adapter Matrix drifted from the shipped CLI. The Codex Smoke cell
referenced a nonexistent harness prepare --platform codex subcommand and a
standalone html-report step (html-report is the HTML validator check id
inside the renderer, not a CLI step); the current chain is
harness analyze --platform codex followed by
harness render --mode html --validate, with the --validate flag written
out because the renderer defaults validation to false.

The Cursor Smoke cell claimed a working --plugin-dir -> evidence bundle ->
validated render chain while roadmap tracks the packaged runtime smoke as open
item U-04; it now marks the smoke as not yet available. The binary name was
never the issue: agent is the current primary Cursor CLI and cursor-agent
is a legacy alias for the same executable.

The Cursor Default Output cell no longer claims a self-contained HTML +
Markdown pipeline; it marks the durable-report output as pending roadmap U-03,
matching the roadmap "No supported pipeline" record. The guarding
test/better-harness-skill.test.mjs Cursor assertion is updated to the
pending-U-03 marker; the Claude Code row assertion stays unchanged.

This closes roadmap P0 item A-05.

Story: roadmap.md TODO A-05
Spec: docs/specs/2026-07-28-a05-adapter-docs-stale-commands.md
Test: node --test test/agent-customize-architecture.test.mjs test/better-harness-skill.test.mjs test/doc-link-graph.test.mjs test/legacy-product-names.test.mjs (20 pass)

Summary

docs/adapters/README.md smoke and output cells now match the shipped CLI and
the roadmap: the Codex smoke chain uses existing commands with an explicit
--validate, and the Cursor row no longer overstates unshipped output or
runtime smoke support (pending U-03 / U-04). Documentation-only plus one test
assertion update; no runtime behavior changes.

Why

  • Issue/Story: roadmap.md TODO A-05 (P0 documentation-contract fix)
  • User or maintainer outcome: maintainers and coding agents reading the Host
    Adapter Matrix no longer follow nonexistent commands (harness prepare,
    standalone html-report) or assume Cursor durable-report/runtime-smoke
    support that the roadmap tracks as open.

Traceability and Scope

  • Spec/ADR, if applicable: docs/specs/2026-07-28-a05-adapter-docs-stale-commands.md
  • Acceptance criteria addressed:
    • AC-1: Codex Smoke 仅用现存命令且显式写出 harness render --mode html --validaterender-report.mjs 默认 validate=false);harness preparehtml-report 已从 README 移除
    • AC-2: Cursor Smoke 不再声称已存在的 evidence-bundle→render 链,标注 runtime smoke 待 roadmap U-04
    • AC-3: Cursor Default Output 不再声称 self-contained HTML + Markdown,标注待 roadmap U-03,与 roadmap "No supported pipeline" 一致
    • AC-4: test/agent-customize-architecture.test.mjs 不变仍通过;test/better-harness-skill.test.mjs 的 Cursor 断言同步为 pending-U-03 标记,Claude Code 行断言不变
    • AC-5: node --test test/doc-link-graph.test.mjs 通过,无 markdown 链接变动
  • Canonical owners changed: docs/adapters/README.md 主机适配矩阵
  • Explicit non-goals: 不新增 Cursor 报告路由或运行时 smoke(U-03/U-04 保持 open);不改 CLI/renderer/provider 代码;不涉及支持声明一致性测试(A-06 单独分支)

Change Type

  • Feature
  • Bug fix
  • Tests only
  • Documentation/community
  • Refactor with no intended behavior change
  • Dependency, packaging, or infrastructure

Test and Review Evidence

Check Result
node --test test/better-harness-skill.test.mjs test/agent-customize-architecture.test.mjs test/doc-link-graph.test.mjs test/legacy-product-names.test.mjs 20/20 pass
node --test test/better-harness-skill.test.mjs test/doc-link-graph.test.mjs test/legacy-product-names.test.mjs (after 20b6578 spec rewording) 18/18 pass
README cell text vs test regex manually verified character-for-character, incl. (roadmap U-03)

Manual or visual evidence: grep confirmed harness prepare / html-report no
longer appear in docs/adapters/README.md; self-contained HTML + Markdown
remains only on the Claude Code and Codex rows.

Risk and Recovery

  • Compatibility and cross-platform impact: 纯文档 + 一处测试断言更新,无运行时逻辑、无跨平台(Win/macOS/Linux)行为差异
  • Package, plugin, schema, or generated-file impact: 无;不触及 npm 包内容、插件清单、schema 或生成产物
  • Rollback or recovery path: 单一 docs 提交,git revert <sha> 即可完全回退
  • Residual risk or unverified boundary: Cursor host smoke 仍缺失,已如实标注 roadmap U-03/U-04,未做真实 host/runtime 验证

AI Involvement

  • Level: Assisted
  • Human review and validation: 本地 node --test 跑通 better-harness-skill、agent-customize-architecture、doc-link-graph、legacy-product-names 共 20/20;并人工核对 README 单元格文本与测试正则逐字一致

Checklist

  • I followed AGENTS.md, CONTRIBUTING.md, and the relevant canonical-owner guidance.
  • The change is focused and does not include unrelated local or generated state.
  • Tests and documentation match the behavior actually delivered.
  • Markdown links were checked when documentation moved or changed.
  • Cross-platform behavior was considered for Windows, macOS, and Linux.
  • Package/runtime verification was run when shipped files or dependencies changed.
  • User-facing or compatibility changes are recorded in CHANGELOG.md.
  • I have the right to contribute this work under the repository's MIT License.

The Host Adapter Matrix drifted from the shipped CLI. The Codex Smoke
cell referenced a nonexistent `harness prepare --platform codex` command
and an `html-report` validation step; the current chain is
`harness analyze --platform codex` followed by a validated
`harness render --mode html`. The Cursor Smoke cell claimed a working
`agent --plugin-dir` -> evidence bundle -> validated render chain while
roadmap records the Cursor runtime smoke as missing (open item U-04); it
now names the correct cursor-agent binary and marks the smoke as not yet
available instead of overstating support.

This closes roadmap P0 item A-05. Default Output columns stay unchanged;
the durable-HTML defaults are an accepted contract guarded by
test/better-harness-skill.test.mjs.

Story: roadmap.md TODO A-05
Spec: docs/specs/2026-07-28-a05-adapter-docs-stale-commands.md
Test: node --test test/agent-customize-architecture.test.mjs test/better-harness-skill.test.mjs test/doc-link-graph.test.mjs (19 pass)

@phodal phodal left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Story/Spec/commit chain is clear, the diff is focused, and validation is green: the declared focused command passes 19/19 locally, all four GitHub CI jobs pass 833/833 with package verification, the doc-link graph is current, and git diff --check passes.

Requesting changes for three documentation-contract blockers:

  1. docs/adapters/README.md:22 claims a validated harness render --mode html step, but the renderer defaults validation to false and only runs validators with --validate. The new spec itself defines the correct chain as harness render --mode html --validate. Please include the flag explicitly.

  2. docs/adapters/README.md:24 still declares Cursor Default Output as self-contained HTML + Markdown, while roadmap.md says Harness analysis is No, Durable report is No supported pipeline, and U-03 is still open. A-05 says not to overstate Cursor output support. Please either mark output pending U-03, or establish the Cursor route with an explicit Cursor spec and executable evidence and then update the roadmap. A string assertion is not host/runtime proof.

  3. docs/specs/2026-07-28-a05-adapter-docs-stale-commands.md:27 and :63-64 incorrectly describe agent as the wrong binary. The live official installer at https://cursor.com/install labels agent as primary and cursor-agent as legacy; both point to the same 2026.07.23 executable, whose help uses Usage: agent and supports --plugin-dir. The missing contract is the real Better Harness Cursor host smoke, not the binary name. Please reword the spec and plan accordingly.

Please also complete the PR template Acceptance Criteria, Risk/Recovery, and AI Involvement fields. Risk and AI evidence are currently missing or unavailable and cannot be inferred from authorship or prose.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

该 PR 旨在修复 Host Adapter Matrixdocs/adapters/README.md)中与当前已发布 CLI 不一致的烟测(smoke)命令描述,并在路线图中勾选已完成的 A-05,同时补充一份可追溯的规格说明(spec)来记录意图与验收标准。

Changes:

  • 更新 Host Adapter Matrix:Codex smoke 命令改为 harness analyze --platform codex + HTML 渲染链路;Cursor smoke 改为明确“尚不可用”,并指向路线图 U-04。
  • 新增 A-05 对应 spec:记录 drift 背景、验收场景与测试证据。
  • 路线图 roadmap.md 将 A-05 标记为完成。

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
roadmap.md 将 P0 A-05 标记为已完成,以匹配本次文档修复的交付状态。
docs/specs/2026-07-28-a05-adapter-docs-stale-commands.md 新增 A-05 规格,描述问题来源、验收标准与测试证据。
docs/adapters/README.md 修正 Codex/Cursor 的 smoke 描述,避免引用不存在或过度承诺的链路。

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/specs/2026-07-28-a05-adapter-docs-stale-commands.md Outdated
Comment thread docs/adapters/README.md Outdated
creayma added 2 commits July 29, 2026 10:30
Resolve the three CHANGES_REQUESTED blockers on PR QoderAI#10:

- Codex Smoke cell now writes `harness render --mode html --validate`
  explicitly, since render-report.mjs defaults validate to false.
- Cursor Default Output no longer claims a self-contained HTML + Markdown
  pipeline; it marks the durable-report output pending roadmap U-03, matching
  the roadmap "No supported pipeline" record.
- Spec reworded so `agent`/`cursor-agent` are described as aliases for the same
  executable; the real missing contract is a Cursor host smoke (U-04), not the
  binary name.

The guarding better-harness-skill test Cursor assertion is updated to the
pending-U-03 marker; the Claude Code row assertion stays unchanged.

Spec: docs/specs/2026-07-28-a05-adapter-docs-stale-commands.md
Test: node --test better-harness-skill agent-customize-architecture doc-link-graph legacy-product-names (20/20)
AI: Assisted
Address the Copilot inline comment on PR QoderAI#10: the A-05 spec claimed the
`html-report` validation step does not exist, but `html-report` is the real
HTML validator check id defined in scripts/harness-analysis/renderers/html.mjs
and asserted by test/harness-report-render-cli.test.mjs. Reword the Intent so
only the `prepare` subcommand and a standalone `html-report` CLI step are
called nonexistent, while validation runs through
`harness render --mode html --validate`.

Spec: docs/specs/2026-07-28-a05-adapter-docs-stale-commands.md
Test: node --test better-harness-skill doc-link-graph legacy-product-names (18/18)
AI: Assisted
@creayma-del
creayma-del requested a review from phodal July 29, 2026 03:18
Resolve the docs/adapters/README.md matrix conflict introduced by the Qwen
Code host adapter (QoderAI#6): keep this branch's reviewed Cursor row (Default
Output pending U-03, runtime smoke pending U-04) and keep the new Qwen Code
row, updating its Smoke cell from the nonexistent
`harness prepare --platform qwen` -> `html-report` chain to the current
`harness analyze --platform qwen` -> `harness render --mode html --validate`
chain, matching A-05 AC-1 (no stale `harness prepare` / standalone
`html-report` strings in the matrix; `--platform qwen` is accepted by
scripts/harness-analysis/report-run.mjs).

Test: node --test better-harness-skill agent-customize-architecture doc-link-graph legacy-product-names (21/21)
AI: Assisted
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.

3 participants